Règles de codage

Les règles de codage sont un ensemble de règles à suivre pour uniformiser les pratiques de développement logiciel, diffuser les bonnes pratiques de développement et éviter les erreurs de développement "classiques" au sein d'un groupe de développeurs.

Les règles de codage s'articulent autour de plusieurs thèmes, les plus courants étant:

• Le nommage et l'organisation des fichiers du code source
• L'indentation ou le style d'indentation
• Les conventions de nommage, ou règles de nommage
• Les commentaires et documentation du code source
• Recommandations sur la déclarations des variables
• Recommandations sur l'écriture des instructions, des structures de contrôle et l'usage des parenthèses dans les expressions.

Les règles de codage permettent d'assurer une meilleure lisibilité du code en utilisant le même style de codage et en évitant les constructions qui rendent le code difficile à lire. Elles participent donc à la qualité logicielle. Ainsi, plus l'importance des développement est élevée, plus les besoins en règles de codages sont élevés. Par exemple, les normes DO-178B pour l'avionique et MISRA C pour l'automobile imposent un ensemble d'objectifs à atteindre sur le logiciel selon la criticité qui lui est attribuée. Cette criticité est déterminée par les contraintes soumises au logiciel (mémoire et CPU disponible, fiabilité, robustesse, etc.) et les risques liés à l'utilisation de ce logiciel (risques humains, risques financiers, etc.). Les règles de codage sont adaptées en conséquence. Par exemple, un logiciel embarqué disposant de peu de mémoire ne devra pas utiliser l'allocation dynamique de mémoire. Autre exemple: le logiciel redondant d'une fusée doit être développé par une équipe totalement indépendante et séparée (pas de partage de code, pas de partage de la conception, etc.) de l'équipe développant le logiciel redondé, le développement devant se faire avec les mêmes contraintes pour les deux équipes.

Logiciels

• Logiciels indentant le code source:
  • environnement de développement intégré (existent pour de multiples langages)
  • indent (C)
  • Perltidy (Perl) ^[1]
• Logiciels vérifiant le respect des conventions de nommage:
  • Checkstyle, FindBugs, PMD (Java)
  • Perl-Critic (Perl) ^[2]
  • PyChecker pour Python
• Logiciels vérifiant les commentaires et la documentation
  • Checkstyle (Java)
  • Perl-Critic (Perl) ^[2]
• Logiciels détectant les erreurs de codage statiquement:
  • Les bons compilateurs et interpréteurs sont capables d'émettre des avertissements lors de l'utilisation de constructions dangereuses:
    • clang (C, C++, Objective-C)^[3].
    • GCC
    • Utilisation du mode strict pour Perl
  • FindBugs, PMD (Java)
  • KLEE, pour les langages pouvant être compilés en bytecode LLVM.
  • PolySpace (Ada, C)
  • Pylint pour Python

Références

1. ↑ Site officiel de perltidy
2. ↑ ^{a et b} Page Perl-Critic sur le CPAN
3. ↑ http://clang.llvm.org/