Les différents types de commentaires

• Par Emacs
• 1 commentaire
• 31557 lectures
• RSS -  Atom

Comme dans tout autre langage de programmation, PHP dispose de sa syntaxe de commentaires. Il en existe d'ailleurs plusieurs sortes que nous allons détailler. Les commentaires font partie des éléments triviaux dans la réussite d'un programme; et c'est pourquoi il est important de les utiliser avec intelligence.

Un commentaire, c'est quoi ?

Un commentaire, dans un langage de programmation, est une ligne écrite en langage naturel (langue maternelle du développeur par exemple) qui ne sera pas exécutée par l'interprêteur (ou le compilateur selon le langage employé). Sa fonction est de décrire ou bien d'expliquer une partie du code qui se révèlerai délicate à déchiffrer en cas de maintenance ou de travail collaboratif (plusieurs développeurs travaillant sur le même programme).

Les commentaires sont donc particulièrement utiles pour un développeur solitaire, mais ils le sont davantage lorsque c'est une équipe complète qui travaille sur un même projet. Ils permettent entre autre d'imposer des nomenclatures et une organisation dans l'écriture du code d'un projet collaboratif. De plus, les commentaires assurent une maintenance plus aisée du programme par son auteur ou une tierce personne.

Un autre point fort des commentaires est la génération de documentation technique. En effet, il existe des applications telles que PHPDocumentor qui s'appuie sur une syntaxe particulière des commentaires afin de générer la documentation d'une application. Cela assure un gain de temps non négligeable pour une équipe de développement.

Commenter un code fait aussi partie des bonnes pratiques à adopter en programmation. Mais il ne faut tout de même pas entrer dans l'excès inverse où chaque instruction du code deviendrait commentée. La clarté et la lisibilité du programme en seraient alors atteintes.

Le commentaire linéaire

Il existe deux sortes de commentaire. Le commentaire sur une seule ligne et le commentaire multilignes. Etudions ensemble les deux méthodes pour commenter un texte sur une seule ligne.

Les commentaires sur une seule ligne
<?php
 
  // Ceci est un premier commentaire sur une ligne
  echo 'Hello World !';
 
  # Ceci est un second commentaire sur une ligne
  echo 'Bonjour le monde !';
 
?>

PHP propose deux manières de commenter un texte placé sur une ligne. La méthode la plus employée est celle du premier exemple avec le double slash (//) contrairement à la seconde utilisant un signe dièse (#).

Le commentaire multilignes

Il permet de commenter un texte écrit sur plusieurs lignes. Il est très fréquemment utilisé par les développeurs. Ces commentaires sont définis au moyen des symbôles /* et */. L'exemple ci-après illustre leur emploi.

Les commentaires multilignes
<?php
  /*
    Ce programme a été écrit par Emacs
  
    Il affiche la chaîne 'Hello Word !' à l'écran
  */
  echo 'Hello World !';
?>

Conclusion

Nous avons défini ce qu'est un commentaire et comment il s'emploie selon qu'il est linéaire ou multilignes. Il faut donc penser à toujours les utiliser dans vos programmes afin d'assurer une relecture et une maintenance facilitées de votre code.