Comment et pourquoi commenter dans votre code PHP
Share
Un commentaire en code PHP est une ligne qui n'est pas lue dans le cadre du programme. Son seul but est d'être lu par quelqu'un qui édite le code. Alors pourquoi utiliser des commentaires?
- Faire savoir aux autres ce que vous faites. Si vous travaillez avec un groupe de personnes ou prévoyez que quelqu'un d'autre utilise votre script, les commentaires indiquent aux autres programmeurs ce que vous faisiez à chaque étape. Cela leur permet de travailler plus facilement et de modifier votre code si nécessaire.
- Pour te rappeler ce que tu as fait. Bien que vous puissiez simplement écrire un script rapide pour vous-même et ne voyez pas la nécessité de commentaires, allez-y et ajoutez-les de toute façon. La plupart des programmeurs ont expérimenté revenir pour éditer leur propre travail un an ou deux plus tard et avoir à comprendre ce qu'ils ont fait. Les commentaires peuvent vous rappeler vos pensées lorsque vous avez écrit le code.
Il existe plusieurs façons d'ajouter un commentaire dans le code PHP. La première consiste à utiliser // pour commenter une ligne. Ce style de commentaire sur une seule ligne ne commente que la fin de la ligne ou le bloc de code actuel, selon la première éventualité. Voici un exemple:
écho "bonjour";
// c'est un commentaire
l'écho "là";
?>
Si vous avez un commentaire sur une seule ligne, une autre option consiste à utiliser un signe #. Voici un exemple de cette méthode:
écho "bonjour";
#ceci est un commentaire
l'écho "là";
?>
Si vous avez un commentaire sur plusieurs lignes plus long, la meilleure façon de commenter est avec / * et * / avant et après un long commentaire. Vous pouvez contenir plusieurs lignes de commentaires à l'intérieur d'un bloc. Voici un exemple:
écho "bonjour";
/ *
Utilisation de cette méthode
vous pouvez créer un bloc de texte plus grand
et tout sera commenté
* /
l'écho "là";
?>
Ne pas mélanger les commentaires
Bien que vous puissiez imbriquer des commentaires dans des commentaires en PHP, faites-le soigneusement. Tous ne nichent pas aussi bien. PHP prend en charge les commentaires de style shell C, C ++ et Unix. Les commentaires de style C se terminent au premier * / ils rencontrent, donc ne pas imbriquer les commentaires de style C.
Si vous travaillez avec PHP et HTML, sachez que les commentaires HTML ne signifient rien pour l'analyseur PHP. Ils ne fonctionneront pas comme prévu et sont susceptibles d'exécuter certaines fonctions. Alors, restez loin de:
