Règles de codage

Un article de Wikipédia, l'encyclopédie libre.
Aller à : navigation, rechercher

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:


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 ou à modifier. Elle permettent également d'éviter les erreurs liées au langage pouvant donner des résultats incorrects, pouvant entraîner des crashs systèmes ou des failles de sécurité. Certaines règles sont également liées aux buts poursuivis par le projet logiciel: portabilité, contraintes mémoires, criticité, etc.

Les règles de codage participent à la qualité logicielle. Ainsi, plus l'importance des développement est élevée, plus les besoins en règles de codages est nécessaire. Ainsi, 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.

Il n'y a pas de règle de programmation absolue, et il appartient à chaque projet logiciel de définir celles qui lui correspondent le mieux.

Tout manquement à une règle de programmation est appelée une violation de règle.

Exemples[modifier | modifier le code]

Exemples de règles facilitant la maintenance du code:

  • facilitant la lecture:
  • facilitant la modification:
    • en C, C++ et Java, mettre les blocs if et else entre accolades.

Exemples de règles évitant les erreurs de programmation:

  • en C, il est interdit de lire une variable non initialisée.
  • en C, il est interdit d'utiliser la fonction char* gets(char* tampon) (Dépassement de tampon assuré lorsque la chaîne de caractère à lire est plus longue que le tampon).
  • en C, il est interdit d'utiliser l'allocation dynamique (cas d'un projet embarqué avec une ressource mémoire limitée).
  • en Java, il est interdit d'utiliser l'affectation dans la condition d'un if.

Exemples de règles facilitant la portabilité:

  • en C et C++, deux nombres flottants ne doivent pas être comparés pour une stricte égalité.
  • en C et C++, ne pas faire d'assomption sur l'endianness (big-endian ou little-endian) du processeur.

Vérification des règles de programmation[modifier | modifier le code]

La vérification d'un ensemble de règles de programmation est généralement faite lors d'une revue de code ou bien d'un audit de code, manuellement ou bien automatiquement afin de trouver les violations de règles de programmation, dans le but de les corriger.

La revue de code vérifie entre autres qu'un nouveau code source est conforme aux règles de programmation avant que ce nouveau code source n'intègre la base de code existante.

L'audit de code vérifie que la base de code existante est conforme aux règles de programmation.

L'analyse statique de programmes permet de vérifier automatiquement qu'une base de code satisfait des règles de programmation. Elle permet de gagner un temps précieux lorsque le nombre de règles est important, ou lorsque la base de code est grande (nombre de lignes de code).

Logiciels liés aux règles de codage[modifier | modifier le code]

Règles de programmation[modifier | modifier le code]

  • Java
  • C
  • Python
    • PEP 8 : Style Guide for Python Code[9]

Règles de programmation normalisées[modifier | modifier le code]

  • MISRA C : ensemble de règles initialement réalisées pour l'automobile et maintenant largement utilisées.
  • MISRA C++ : version de MISRA C adaptée au langage C++
  • DO-178B : le niveau C impose de définir des règles de programmation pour le projet.

Références[modifier | modifier le code]

  1. Site officiel de perltidy
  2. a et b Page Perl-Critic sur le CPAN
  3. http://clang.llvm.org/
  4. [1]
  5. [2]
  6. [3]
  7. (en) http://www.oracle.com/technetwork/java/codeconv-138413.html
  8. (en) http://www.gnu.org/prep/standards/
  9. (en) http://www.python.org/dev/peps/pep-0008/