05-09-2009, 02:02 AM
Il y a la pratique de l'Extreme Programming (si un code a besoin de commentaire c'est qu'il peut être réécrit). Pour ça, de toutes façon il faut être dans une équipe qui pratique l'XP et (je n'ai jamais pu expérimenter) ce doit ne pas être gênant.
Il y a ensuite la pratique naïve :
Et il y a une approche classique qui cherche à décrire le choix qui a été fait dans le code pour en arriver à telle ligne. J'ai toujours fait ainsi : on pense que son collègue qui cherche pourquoi une telle ligne (mais pourquoi il fait $truc = $trac ici?), qui cherche à comprendre rapidement le code (les petits commentaires décrivant la macro fonction d'un groupe de code peut aider)... Bref, des commentaires permettant une lecture en diagonale du code.
Une remarque que m'a donné un professionnel : les commentaires ne sont pas maintenus. En pensant à ça, on réfléchit aux commentaires à mettre et ceux qui peuvent éventuellement être susceptible de changer avec le code...
Il y a ensuite la pratique naïve :
$compteurDeBaballes++; // on incrémente le compteur de baballes de 1
if ($compteurDeBaballes > 10) // si le compteur de baballe est plus grand que 10
...
Et il y a une approche classique qui cherche à décrire le choix qui a été fait dans le code pour en arriver à telle ligne. J'ai toujours fait ainsi : on pense que son collègue qui cherche pourquoi une telle ligne (mais pourquoi il fait $truc = $trac ici?), qui cherche à comprendre rapidement le code (les petits commentaires décrivant la macro fonction d'un groupe de code peut aider)... Bref, des commentaires permettant une lecture en diagonale du code.
Une remarque que m'a donné un professionnel : les commentaires ne sont pas maintenus. En pensant à ça, on réfléchit aux commentaires à mettre et ceux qui peuvent éventuellement être susceptible de changer avec le code...