Les commentaires


Bon, mine de rien je viens de vous apprendre pas mal de choses d'un coup, ça doit vous faire un choc. D'accord ce n'était pas extraordinaire, mais vous n'allez pas tarder à comprendre toute la subtilité de la chose.

Avant de terminer ce chapitre, je tiens à vous parler de quelque chose qui à mes yeux a une très grande importance en PHP, comme dans tout langage de programmation : les commentaires.

Un commentaire est un texte que vous mettez pour vous dans le code PHP. Ce texte est ignoré, c'est-à-dire qu'il disparaît complètement lors de la génération de la page. Il n'y a que vous qui voyez ce texte.

Mais alors, à quoi sert un commentaire ?



C'est pour vous. Cela permet de vous y retrouver dans votre code PHP, parce que si vous n'y touchez pas pendant des semaines et que vous y revenez, vous risquez d'être un peu perdus.
Vous pouvez écrire tout et n'importe quoi, le tout est de s'en servir à bon escient.

Il existe deux types de commentaires :

  • les commentaires monolignes ;
  • les commentaires multilignes.

Tout dépend de la longueur de votre commentaire. Je vais vous présenter les deux.


Les commentaires monolignes



Pour indiquer que vous écrivez un commentaire sur une seule ligne, vous devez taper deux slashs : « // ». Tapez ensuite votre commentaire.
Un exemple ? 

Code : PHP

1

2

3

4

5

6

<?php

echo "J'habite en Chine."; // Cette ligne indique où j'habite


// La ligne suivante indique mon âge

echo "J'ai 92 ans.";

?>



Je vous ai mis deux commentaires à des endroits différents :

  • le premier est à la fin d'une ligne ;
  • le second est sur toute une ligne.

À vous de voir où vous placez vos commentaires : si vous commentez une ligne précise, mieux vaut mettre le commentaire à la fin de cette ligne.


Les commentaires multilignes



Ce sont les plus pratiques si vous pensez écrire un commentaire sur plusieurs lignes, mais on peut aussi s'en servir pour écrire des commentaires d'une seule ligne. Il faut commencer par écrire /* puis refermer par */ :

Code : PHP 

1

2

3

4

5

6

<?php

/* La ligne suivante indique mon âge

Si vous ne me croyez pas...

... vous avez raison ;o) */

echo "J'ai 92 ans.";

?>



Ici, les commentaires n'ont pas grande utilité, mais vous verrez de quelle façon je les utilise dans les prochains chapitres pour vous décrire le code PHP.

Créé avec HelpNDoc Personal Edition: Créez sans effort un site Web de documentation de qualité professionnelle avec HelpNDoc