PHPDoc : Différence entre versions
De OviWiki
| Ligne 1 : | Ligne 1 : | ||
Commenter un code est la meilleure aide que vous pouvez donner aux développeurs qui réutiliseront votre code. | Commenter un code est la meilleure aide que vous pouvez donner aux développeurs qui réutiliseront votre code. | ||
| − | Pour cela, nous conseillons d'utiliser la syntaxe de PHPDoc pour vos commentaires. PHPDoc est une adaptation de JavaDoc au langage PHP. Un commentaire écrit en PHPDoc sera facilement compréhensible par un développeur ainsi que par des logiciels générateurs de documentations ([http://www.phpdoc.org PHPDocumentor], [http://www.stack.nl/~dimitri/doxygen Doxygen], [http://www.phpdoc.de PHPDoc]...). | + | Pour cela, nous conseillons d'utiliser la syntaxe de PHPDoc pour vos commentaires. PHPDoc est une adaptation de JavaDoc au langage PHP. Un commentaire écrit en PHPDoc sera facilement compréhensible par un développeur ainsi que par des logiciels générateurs de documentations ([http://www.phpdoc.org PHPDocumentor], [http://www.stack.nl/~dimitri/doxygen Doxygen], [http://www.phpdoc.de PHPDoc], [http://naholyr.free.fr/autophpdoc AutoPHPDoc]...). |
| + | ==Exemples de commentaires== | ||
| + | Commentaire sur une variable de classe : | ||
<source lang="php"> | <source lang="php"> | ||
| − | /** | + | /** |
| − | * | + | * Message de bienvenue |
| − | + | ||
* | * | ||
| − | * @var string | + | * @var string message de bienvenue |
* @access private | * @access private | ||
*/ | */ | ||
| − | var $ | + | var $message; |
| + | </source> | ||
| + | Commentaire sur une méthode de classe : | ||
| + | <source lang="php"> | ||
/** | /** | ||
| − | * | + | * Créé le message |
| − | * | + | * et le stocke dans $this->message |
* | * | ||
| − | * @access | + | * @access public |
* @return none | * @return none | ||
*/ | */ | ||
| − | function | + | function creationMessage() { |
} | } | ||
</source> | </source> | ||
| + | |||
| + | ==Syntaxes== | ||
Version du 26 mai 2009 à 13:24
Commenter un code est la meilleure aide que vous pouvez donner aux développeurs qui réutiliseront votre code.
Pour cela, nous conseillons d'utiliser la syntaxe de PHPDoc pour vos commentaires. PHPDoc est une adaptation de JavaDoc au langage PHP. Un commentaire écrit en PHPDoc sera facilement compréhensible par un développeur ainsi que par des logiciels générateurs de documentations (PHPDocumentor, Doxygen, PHPDoc, AutoPHPDoc...).
Exemples de commentaires
Commentaire sur une variable de classe : <source lang="php">
/**
* Message de bienvenue
*
* @var string message de bienvenue
* @access private
*/
var $message;
</source>
Commentaire sur une méthode de classe : <source lang="php">
/**
* Créé le message
* et le stocke dans $this->message
*
* @access public
* @return none
*/
function creationMessage() {
}
</source>
