« Programmation PHP/Commentaires » : différence entre les versions

Un commentaire n'est pas censé être indispensable
(Déplacé de la page précédente)
 
(Un commentaire n'est pas censé être indispensable)
 
== Principe ==
Les commentaires sont en réalité des portions de texte qui ne seront pas interprétées par PHP et ne seront visibles que dans le code source. Ils jouent un rôle très important dans la réalisation et la mise à jour d'un script : en effet, les commentaires rendent le code plus lisible et peuvent aider les éventuelles personnes qui souhaitent retravailler votre script. En effet, si les commentaires sont très utiles aux programmeurs seuls, ils le sont encore plus lors du travail en équipe.
 
Il existe trois façons différentes d'ajouter des commentaires à son script PHP :
|clear=left}}
 
== Annotations ==
=== Standardisation des commentaires ===
Les commentaires sont très utiles aux programmeurs, mais se révèlent surtout indispensables lors de travail en équipe. Il existe en outre des logiciels qui génèrent une documentation complète à partir des commentaires insérés dans le code du programme. De là est apparue une certaine forme de standardisation de ceux-ci afin de faciliter la génération de documentation, appelée {{w|PHPDoc}}. On peut en effet ajouter des commentaires structurés pour permettre de générer une documentation automatique via PEAR<ref>http://pear.php.net/manual/en/standards.sample.php</ref> ou phpDocumentor<ref>http://www.phpdoc.org</ref>{{w|PhpDocumentor}}. Exemple<ref>http://www.phpascal.com/programmationEn pratique, cela se traduit par des mots-web/PHP/commentaire-phpclés interprétés, précédés d'un arobase, appelés "annotations".html</ref> :
 
Exemple<ref>http://www.phpascal.com/programmation-web/PHP/commentaire-php.html</ref> :
<syntaxhighlight lang="php">
/**
* Commentaires sur le rôle du fichier courant
*
</syntaxhighlight>
 
== Références ==
Les commentaires ainsi interprétés (ex : variables après arobase) sont appelés des annotations.
{{Références}}