Commentaires de code

Pour realiser la documentation technique nous utilisons une norme commune a beaucoup de languages avec une implementation faite par phpDocumentor : http://www.phpdoc.org/

Les balises possibles sont definies sur cette page : http://www.phpdoc.org/docs/latest/guides/docblocks.html

Pour une premiere passe de documentation, on se limitera a :

• http://www.phpdoc.org/docs/latest/guides/docblocks.html#anatomy-of-a-docblock
• http://www.phpdoc.org/docs/latest/references/phpdoc/tags/var.html
• http://www.phpdoc.org/docs/latest/references/phpdoc/tags/param.html
• http://www.phpdoc.org/docs/latest/references/phpdoc/tags/return.html

Donc un resume court et une liste de parametre, ainsi que le retour de la fonction si il existe.