Les blocs de commentaire de la documentation en ligne (docblocks)
doivent être fournis.
Lisez les sections sur le
fiche exemple et sur les
blocs d'en-tête des commentaires
sur les standarts de codage pour apprendre les spécificité de
l'écrituredocblocks pour les paquets PEAR.
Plus d'informations peuvent être trouvées sur le site web de
la phpdocumentor.
Les commentaires non inclus dans la documentation sont vivement
encouragés.
La règle générale est que, si en regardant une portion de code,
vous pensez << Wauouh, je ne veux pas me lancer dans cette explication >>,
il faut absolument la commenter tout de suite
avant que vous n'oubliez comment cela fonctionne.
Les commentaires du type C (/* */) et les commentaires standard C++ (//)
sont tous les deux acceptés.
Les commentaires de type Perl/shell (#) sont à éviter.
