La qualité d'un code source passe par sa lisibilité.
Un code difficile à lire a de plus grande chance de contenir des bugs qu'un code facile à lire !
La lisibilité du code est une notion objective, de plus en plus mesurable automatiquement. Il existe en effet plusieurs règles de rédaction du code qui font consensus dans tous les langage de programmation.
Ces règles précisent des contraintes quant à la rédaction du code. On trouve notamment des règles expliquant :
- comment indenter son code
- comment nommer les variables, les fonction, les classes
- comment imbriquer les conditions
- comment limiter les dépendances entre classes
- etc.
Même si les règles de rédaction du code existante aujourd'hui ne font pas toutes consensus, il faut absolument que les développeurs s'accordent sur certaines d'entre elles, et définissent ainsi leur convention de codage pour le logiciel.
L'objectif est de définir une sorte de charte de codage, imposant un style uniforme que tous les développeurs partagent.
Sans cet ensemble de règles chaque développeur pourra alors rédiger le code comme bon lui semble. Le code ne sera alors pas homogène d'un point de vue lisibilité, ce qui entrainera une baisse de sa qualité.
La lisibilité du code doit être automatisée. Cela passe par la mise en place de linters, qui sont des outils permettant de vérifier automatiquement la conformité du code aux règles de codage.
Si certaines règles ne sont pas détectable automatiquement, la lisibilité du code ne pourra se faire que grâce à un audit réalisé par un expert.