PageWikiniArchive Aucune page n'a de lien vers ConvCodCommentaires.
La documentation des fichiers, classes, fonctions et constantes incluses dans le code source doit suivre la convention PHPDocumentor, similaire à celle de Javadoc.
Pour plus d'information au sujet de PHPDocumentor vous reporter à : http://phpdocu.sourceforge.net/
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 "Wououh, je ne veux pas me lancer dans cette explication", il faut 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.
Commentaires
La documentation des fichiers, classes, fonctions et constantes incluses dans le code source doit suivre la convention PHPDocumentor, similaire à celle de Javadoc.
Pour plus d'information au sujet de PHPDocumentor vous reporter à : http://phpdocu.sourceforge.net/
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 "Wououh, je ne veux pas me lancer dans cette explication", il faut 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.