PHP – Les commentaires
Les commentaires permettent de donner des indications dans le script, afin de faciliter sa compréhension au
lecteur.
Ils sont particuliérement utiles lorsque l’on travaille à plusieurs sur un même site web, ou bien lorsque
l’on doit parfois relire un script écrit il y a plusieurs mois.
Certaines personnes, faisant surtout partie de la communauté Linux, soutiennent qu’un code écrit clairement,
sans astuces de programmeurs n’a pas besoin de commentaires. Chacun son école…
La syntaxe des commentaires en PHP est à la fois inspirée du C, du C++ et du système d’exploitation Unix/linux.
Voici les differents types. Les commentaires sont ecrits en vert :
# Début du script
/*
Voici un script merveilleux
qui sert à donner l'heure à
laquelle la page à été chargée
*/
print date("H:M:S"); // On écrit l'heure sous le format H:M:S
# Fin du script
Tous ce qui se trouve à l’interieur d’un commentaire est tout simplement ignoré par l’interpréteur.
Les commentaires avec /* et */ sont hérités du langage C. Comme on le voit, ils
permettent de commenter du code sur plusieurs lignes. Ce type de commentaire peut être utile lors de la
mise au point d’un script. On peut avoir besoin d’ignorer plusieurs lignes de code, sans pour autant avoir
envie de les supprimer.
Les commentaires en // (qui nous viennent du C++) s’achevent avec la fin de la ligne,
comme pour les commentaires débutant avec #. Ces derniers sont souvent utilisés dans des fichiers
de configuration qui initialisent de nombreuses variables (dans des scripts comme phpBB, phpNuke, phpMyAdmin, etc…),
ceci afin de garder un style Unix.