Conseils utiles

Leçon 6

Les commentaires en PHP lors de l'exécution du script sont ignorés par le préprocesseur et ne sont nécessaires que pour les utilisateurs. Les développeurs négligent souvent les commentaires de code.

Les programmeurs sont d’avis qu’ils se souviendront du fonctionnement du code et six mois et un an plus tard. Une autre raison de ne pas laisser de commentaires est la conviction que le code est si bien écrit qu'il est clair et sans explication. Mais vous devez vous rappeler qu'il peut être nécessaire de continuer à maintenir les scripts PHP créés longtemps après leur écriture.

Une raison tout aussi importante pour commenter le code est de s'assurer que les suiveurs prennent en charge ou ajoutent des fonctionnalités à votre création. Ils bénéficieront également de la lecture des commentaires laissés.

PHP propose deux façons de commenter: une pour les commentaires sur une ligne et la seconde pour les commentaires sur plusieurs lignes. PHP prend la syntaxe des commentaires de C, C ++ et Java. Donc, si vous les connaissez, alors il n'y aura pas de surprises pour vous.

PHP Single Line Commentaires

Avant les commentaires qui se trouvent sur la même ligne, deux barres obliques (//) sont placées dans PHP.

L'exemple suivant contient un commentaire PHP d'une seule ligne dans le code:

Un commentaire d'une seule ligne peut être sur une ligne séparée ou ajouté à la fin d'une ligne de code:

Dans l'exemple ci-dessus, le préprocesseur PHP exécutera la fonction echo et ignorera tout après //.

Les commentaires sur une seule ligne sont également utilisés pour supprimer temporairement les lignes de code d'un thread d'exécution. Par exemple, la modification suivante apportée à l'exemple précédent amènera PHP à ignorer la commande echo complète au moment de l'exécution:

Commentaires PHP multi-lignes

Les commentaires multilignes pour le site PHP sont entourés de délimiteurs / * et * /. Le symbole / * indique le début d'un bloc de commentaires et * / indique sa fin. L'exemple suivant illustre l'utilisation du commentaire multiligne:

Les commentaires sur plusieurs lignes sont utiles lorsque les notes que vous souhaitez insérer dans le code prennent plus d'une ligne. La possibilité de marquer des blocs de ligne en tant que commentaires évite l'utilisation d'un commentaire de ligne unique au début de chaque ligne.

Une autre utilisation utile des commentaires multilignes est de désactiver temporairement les blocs de code PHP. Une pratique courante consiste à écrire un script PHP et à réfléchir à la possibilité de le réécrire pour qu'il devienne plus efficace. Dans ce cas, vous pouvez commenter l'ancien code afin qu'il ne soit plus exécuté et en écrire un nouveau. S'il s'avère que le nouveau code est pire que l'original, vous pouvez supprimer les commentaires et le nouveau code en PHP. Et puis décommentez l'ancien pour le renvoyer au fil d'exécution.

Des commentaires sur une ou plusieurs lignes peuvent être facilement ajoutés au code PHP en utilisant une syntaxe spéciale. Essayez de développer l'habitude de commenter votre code.

Maintenant que nous avons appris quelques concepts de base de PHP, il est temps d’apprendre les bases de ce langage de programmation, en commençant par l’introduction de variables PHP.

Cette publication est une traduction de l'article "Commenting PHP Code" préparé par l'équipe amicale du projet Internet technology.ru

Commentaire syntaxe php: commentaire sur une seule ligne

Alors qu'en HTML, il n'y a qu'un seul type de commentaire, en PHP il y en a autant que deux. Le premier type que nous discuterons est un commentaire d’une ligne. C’est-à-dire un commentaire qui dit à l’interprète d’ignorer tout ce qui se passe sur cette ligne à la droite des commentaires. Pour utiliser ce commentaire, utilisez les caractères “//” ou “#” et tout le texte à droite sera ignoré par l'interpréteur PHP.

Veuillez noter que plusieurs de nos commandes d'écho n'ont pas été traitées car nous les avons commentées à l'aide de caractères de commentaire spéciaux. Ce type de commentaire est souvent utilisé pour écrire rapidement un code complexe et déroutant ou pour supprimer temporairement une ligne de code PHP (pour le débogage).

Commentaire syntaxe php: commentaire sur plusieurs lignes

Comme les commentaires HTML, les commentaires multilignes en PHP peuvent être utilisés pour commenter de gros blocs de code ou pour écrire des commentaires sur plusieurs lignes. Les commentaires multi-lignes en PHP commencent par "/ *" et se terminent par "* /". Tout ce qui se trouve entre ces personnages sera ignoré.

Commenter le code est bon!

Commenter est quelque chose que je peux recommander à tous les programmeurs novices en PHP. Commentez votre code! Tant de gens écrivent du code complexe en PHP et sont soit trop paresseux pour écrire de bons commentaires, soit pensent que les commentaires ne sont pas nécessaires. Cependant, croyez-vous vraiment pouvoir vous rappeler exactement ce que vous pensiez lorsque vous avez écrit ce code il y a un an ou plus?

Ecrivez des commentaires aujourd'hui et vous vous en remercierez à l'avenir! :) Mettre deux barres obliques et gribouiller quelques mots sur le code n'est pas difficile, mais cela vous sera très utile si vous y revenez après un certain temps!

Commentaires:

  1. Misha - 03/04/2013 12:47

Oui, commenter le code est très important, je suis tout à fait d'accord avec l'auteur!

Sergey - 25/03/2013 21h46

J'ai tout compris, mais même le texte du fichier index.pxp ne s'affiche pas pour moi, rien de plus. Dans le même dossier, le texte du fichier menu.pxp

Sergey, honnêtement, je n'ai rien compris) Qu'est-ce qui n'est pas affiché et où? Les commentaires ne doivent pas être affichés - ils ne sont visibles que dans le code source de la page.

Stas - 28/02/2017 13:55

Encore plus facile est de mettre un script de commentaires prêts à l'emploi sur un site comme disqus

Vitaly - 23/05/2017 13:30

Stas, hurlant de ta part)) d'où vient le discus? Il ne s'agit pas de commenter sur le site, mais de commenter des morceaux, des blocs ou des lignes de code en PHP - pour que plus tard, il vous soit plus facile de comprendre ce que vous avez écrit, et si quelqu'un d'autre lit le code, ce sera plus facile aussi)))