mercredi 23 Avr 2008

Bien présenter son code

La présentation de son code dans n'importe quel langage est un atout très important à la compréhension et à la recherche "visuelle". Sur le moment et lorsqu'on reprend quelques semaines, voire quelques mois plus tard, une bonne présentation peut faire la différence entre un développeur rapide et un qui galère. ;-)

Un élément important est bien sûr les tabulations (certains préfèrent les espaces pour être sûr d'avoir le même écartement sur différentes plateformes). Vous devez veillez à bien étager les différents niveaux. En particulier en PHP où du code HTML peut venir s'intercaler dans le PHP, gardez quand même le bon nombre de tabulation pour le PHP (c'est moins important pour l'HTML). Il vous suffira de suivre la colonne pour trouver "où on est".


Je vois souvent des développeurs présenter les accolades { } sans les aligner. C'est une bêtise! On n'est pas à une ligne près, ce n'est pas comme une feuille de papier qu'on paye. :-p

Veillez à bien aligner les accolades ouvrantes et fermantes.

Ceci est valable même dans les fichiers CSS où on n'a qu'un (ou 2) niveaux d'accolades. Celui qui reprendra votre code dans quelques temps (ce sera peut-être vous), vous en remerciera.

Mal:

while (...) {
  if (...) {
    ...
  }
}

Bien:

while (...)
{
  if (...)
  {
    ...
  }
}

Quand on a plusieurs niveaux d'accolades imbriqués, un éditeur de code comme NotePad++, vous permettra de voir immédiatement les accolades correspondantes grâce à un trait vertical. Et même sans ce guide, vous verrez à l'usage qu'il est beaucoup plus rapide de corriger une erreur d'accolade visuellement.

Dans mon exemple simple, si j'oublie l'accolade ouvrante après if, je ne peux pas le voir rapidement si elles ne sont pas alignées.


Une autre erreur couramment faite et de ne pas suffisamment espacer son code. Encore une fois, on ne paye pas le papier, ce n'est pas un livre, ni un brouillon. Laissez 3 ou 4 lignes vides entre 2 fonctions ou 2 parties qui n'ont rien à voir.

Utilisez des commentaires, présentant la suite, ou simplement pour séparer.


/* Fin de ma grosse fonction. */
ou
/*************************/
ou
/* ------------------------- */

Même si vous ne compter jamais générer automatiquement de la documentation avec Doxygen, vous pouvez utiliser la syntaxe pour les commentaires importants car elle est claire et visuelle.


/**
 * La partie suivante sert à l'affichage.
 * Chaque ligne est d'abord décomposée,
 * puis bidouillée, et affichée.
 */


Quelques exemples de l'utilité d'une bonne présentation avec NotePad++
Notepad++ capture 1Notepad++ capture 2Notepad++ capture 3


café Cet article vous a aidé? 
Offrez-moi un café!
Agrégateur informatique

Laisser un commentaire

Azur Dev