Bien commenter son code

Par j0k le dimanche 27 novembre 2005, 04:54 - 1492 vues

Il faut le savoir, quand vous faites un script, il faut penser qu'un jour vous devrez peut être le ré-utiliser. Surtout si vous développez une fonction relativement utile, il ne faut pas hésiter à mettre beaucoup de commentaire pour comprendre comment la fonction fonctionne. Évidemment cela ne sert à rien de mettre juste avant une boucle if, je teste la valeur $var. Je pense que tous le monde est assez logique pour lire le if et le comprendre. Il faut clarifier des points qui vous ne sembleront plus logique lors de la relecture du script quelques mois plutard.
Tout ça pour vous dire que particletree a publié un article sur les "règles" de commentaires. Il présentent ainsi leur vision des commentaires dans le fichiers. Penser aussi à mettre une entête à vous script pour les décrire.

Pensez à vous inscrire !

  • C'est rapide
  • Utiliser votre compte Facebook
  • Ou votre Open ID
Laisser un commentaire





Catégories


Tags


Liens