Il est facile de vous perdre dans les innombrables lignes de code de votre programme. C’est pour cela que vous devez penser à insérer quelques repères comme des commentaires dans votre code. Selon le langage que vous utilisez, vous aurez une méthode à suivre pour insérer des références. Voici comment ajouter des commentaires quand vous travaillez sur du PHP.
Commentaire dans le code PHP : Les astuces pour écrire un commentaire dans le code PHP
Le commentaire dans un PHP se présente sous deux formes. Vous en découvrirez les variantes moins courantes après le clic, car le sujet est également traité sur ce site. Chacune des formes comporte de légères spécificités en fonction de leur utilisation.
Le commentaire en une ligne
La première forme de commentaire utilisée est appelée commentaire linéaire. Désigné simplement par « commentaire à une ligne » chez certains. Il tient sur une seule et même ligne. Il commence par un double slash (//) ou par un hashtag (#). Après ces symboles, vous pouvez ajouter une courte annotation à votre code avant la mention « echo » placée devant ce que vous souhaitez afficher.
Vous terminez le commentaire par un point-virgule ou sans rien ajouter. Ce type de commentaire est souvent inséré dans le code entre les balises « < ? Php » et « ?> » du PHP. Cette courte référence accompagne un bloc de code ou une seule ligne. Elle est écrite en HTML avant d’être exécutée et fonctionnelle.
Le commentaire à plusieurs lignes
La seconde forme de commentaire est appelée commentaire multiligne. Ils sont adaptés pour les longues explications sur votre code. Ils peuvent servir à tester le code ou bloquer l’exécution de certaines portions. Vous devez les écrire entre les symboles (/*) et (*/) composés d’un slash (/) et d’une étoile (*).
À chaque détail ajouté, vous créez une nouvelle ligne en dessous de la précédente. Certains utilisent une étoile (*) au début de chaque ligne créée. Cela reste facultatif parce que le simple fait d’aller à la ligne suffit.
Vous devez comme pour les commentaires linéaires garder la totalité du commentaire à plusieurs lignes dans les balises PHP. Cela suppose que les symboles et leur contenu seront encadrés par « < ? Php » et « ?> ».
Quels autres moyens pour ajouter des commentaires dans le code PHP ?
Les commentaires utilisés dans le PHP et indiqués plus haut utilisent du HTML. Si vous comptez insérer des annotations par d’autres méthodes, vous pouvez utiliser d’autres langages. Le PHP admet l’utilisation d’une multitude de langages pour les commentaires. Ceux-ci incluent :
- C ;
- C++ ;
- Shell Unix (Style Perl).
Entre les balises de PHP, vous pouvez insérer des commentaires encadrés par les symboles adaptés utilisant ces langages. Avec le style C, votre annotation prend fin au premier symbole « */ ». Pour le C++, vous écrivez « style C++ » après le contenu du commentaire précédé de l’élément commenté.
Le code et son annotation sont séparés par un point-virgule, mais c’est le double slash qui commence le commentaire. Avec du Style Perl, vous démarrez par un hashtag « # ». L’usage de ce symbole est conditionné par une option appelée « PCRE_EXTENDED ». Quand elle est activée, les hashtags n’ont pas besoin d’être protégés par les balises.