Section courante

A propos

Section administrative du site

Généralité

Le langage de programmation PHP supporte deux formats de remarque. Le premier format à les syntaxes suivantes :

/* ma remarque */

ou

/* ma remarque
étalé sur plusieurs lignes
...
*/
Comme la seconde syntaxe le démontre on peut étirer les commentaires sur plusieurs lignes ou simplement la mettre sur une ligne, le PHP n'y voit aucune différence.

Le deuxième n'affecte que la ligne courante du code source. Donc, lorsqu'on se retrouve à la ligne suivante, les instructions régulière reprennent et la remarque n'a plus court. Finalement, son format à la syntaxe suivante :

// ma remarque

Remarques

Exemple

Voici un exemple typique de l'utilisation de cette fonction :

Essayer maintenant !
  1. <?php
  2. /* Ceci est un commentaire n'étant pas vue */ 
  3. ?>

phpDocumentor (phpdoc.org)

Bien que non obligatoire au fonctionnement du code source PHP, l'utilisation des conventions du «phpDocumentor» est recommandé pour permettre aux applications (Eclipse, NetBeans,...) de détecter les descriptions et les paramètres des fonctions du code source d'un projet PHP. Voici la liste des balises les plus communes :

Balise Description
@api Cette balise permet d'indiquer un élément de structure visible à partir d'un API publique.
@author Cette balise permet d'indiquer l'auteur de l'élément de structure.
@category Cette balise permet d'indiquer le groupe de modules (packages). Cette balise est obsolète.
@copyright Cette balise permet d'indiquer les droits d'auteur de l'élément de structure.
@deprecated Cette balise permet d'indiquer que l'élément de structure est obsolète.
@example Cette balise permet d'indiquer un exemple de code associé à cette partie.
@filesource Cette balise permet d'indiquer qu'il faut inclure la source du fichier courant dans l'analyse du résultat.
@global Cette balise permet d'indiquer au phpDocumentor que la variable global spécifié est utilisée.
@ignore Cette balise permet d'indiquer au phpDocumentor que l'élément de structure ne doit pas être traité.
@internal Cette balise permet d'indiquer une note sur l'élément de structure interne pour l'application ou la bibliothèque.
@license Cette balise permet d'indiquer la licence de l'élément de structure.
@link Cette balise permet d'indiquer une relation de lien URL avec l'élément de structure.
@method Cette balise permet d'indiquer de faire reconnaitre «magiquement» une méthode d'une classe.
@package Cette balise permet de catégoriser un élément de structure en division logique.
@param Cette balise permet d'indiquer un paramètre d'une méthode ou d'une fonction.
@property-read Cette balise permet d'indiquer si une propriété de classe est en mode lecture seulement.
@property-write Cette balise permet d'indiquer si une propriété de classe est en mode écriture seulement.
@property Cette balise permet d'indiquer la présence d'une propriété dans une classe.
@return Cette balise permet d'indiquer la valeur de retour d'une méthode ou d'une fonction.
@see Cette balise permet d'indiquer une référence vers une association à un élément de structure.
@since Cette balise permet d'indiquer les versions disponibles d'un élément de structure.
@source Cette balise permet d'indiquer une ligne de code source associé à un élément de structure.
@subpackage Cette balise permet de catégoriser un élément de structure en subdivision logique.
@throws Cette balise permet d'indiquer un déclencheur d'exception d'un élément de structure.
@todo Cette balise permet d'indiquer des éléments à terminer dans un élément de structure.
@uses Cette balise permet d'indiquer des éléments externes étant dans un élément de structure.
@used-by Cette balise permet d'indiquer que l'élément de structure est utilisé par une fonction ou une méthode spécifié.
@var Cette balise permet d'indiquer une variable d'une méthode ou d'une fonction.
@version Cette balise permet d'indiquer la version d'une méthode ou d'une fonction.


Dernière mise à jour : Lundi, le 3 août 2015