Dans le code, à chaque action faite, à chaque ligne presque, je place un commentaire qui explique comment fonctionne la fonction, pourquoi je fais faire telle ou telle chose...
je disais ça pour un cas extrême qui nécessite cela (un algo pas évident à comprendre du premier coup, ou pour les appels de variables. exemples :
en début de fichier :
/*
mon_script.php
depends of : machin.php, toto.php maconf.conf
Contents : general function about "trucmush"
functions defined : funcDoingThat, funcDoingThis, funcDoingNothing
*/
et/ou pour une fonction :
/*
funcDoingThat
globalvars : $global1 (defined in maconf.conf)
used funcs : usedFunc (defined in machin.php)
actions ; Do that thing
*/
et, bien entendu, mettre tout ça à jour si modifié
[^] # Re: commenter le code?
Posté par jeffcom . En réponse au journal à quand un code commenté ?. Évalué à 1.
je disais ça pour un cas extrême qui nécessite cela (un algo pas évident à comprendre du premier coup, ou pour les appels de variables. exemples :
en début de fichier :
et/ou pour une fonction :
et, bien entendu, mettre tout ça à jour si modifié