Lorsque vous affichez une page Web dans un navigateur, vous voyez une représentation visuelle de ce que ce logiciel (le navigateur Web) affiche en fonction du code d'une page Web particulière. Si vous affichez le code source de la page Web, vous verrez un document composé de divers éléments HTML, notamment des paragraphes, des en-têtes, des listes, des liens, des images, etc. Tous ces éléments sont rendus par le navigateur sur l'écran du visiteur dans le cadre de l'affichage du site Web. Une chose que vous pouvez trouver dans le code HTML qui n'est pas affichée sur l'écran d'une personne est ce qu'on appelle les "commentaires HTML".
Qu'est-ce qu'un commentaire?
Un commentaire est une chaîne de code HTML, XML ou CSS qui n'est ni visualisée ni utilisée par le navigateur ou l'analyseur. Il est simplement écrit dans le code pour fournir des informations sur ce code ou d'autres commentaires des développeurs de code.
La plupart des langages de programmation ont des commentaires, ils sont couramment utilisés par le développeur du code pour un, voire plusieurs, des raisons suivantes:
- Décrivez et expliquez le code compliqué à une personne susceptible de devoir travailler dessus - y compris à elle-même! Ils peuvent revenir au code 3 ou 6 de 12 mois ou plus plus tard et ne pas se rappeler pourquoi ils ont fait quelque chose d'une certaine manière. Les commentaires peuvent aider à répondre à leurs questions et leur rappeler où était leur esprit quand ils ont développé cette page pour la première fois.
- Fournissez des détails sur le moment où le code a été modifié ou révisé. Cela peut être une information utile et un peu comme un journal de développement indiquant la dernière fois qu'un site a été travaillé.
- Supprimez les sections du code, mais laissez-les disponibles pour une utilisation ultérieure. Cela se fait souvent lors des tests et du débogage du site. Si vous rencontrez un problème sur un site et que vous n'êtes pas certain de sa cause, vous pouvez commenter les sections une par une pour mettre en quarantaine et identifier le problème, puis travailler sur un correctif pour tous vos problèmes.
- Discutez avec d'autres développeurs travaillant sur le code. Cela serait probablement fait pendant le développement afin de partager les détails avec d'autres personnes travaillant simultanément sur le code. Si ces commentaires sont uniquement des conversations de développement, il est recommandé de les supprimer du code avant le lancement d'un site.
Traditionnellement, les commentaires en HTML sont utilisés pour presque tous les éléments, des explications de structures de tableau complexes aux remarques informatives sur le contenu de la page elle-même. Comme les commentaires ne sont pas affichés dans un navigateur, vous pouvez les ajouter n'importe où dans le code HTML et ne vous inquiétez pas de ce qu'il va faire lorsque le site sera visualisé par un client.
Comment écrire des commentaires
Écrire des commentaires en HTML, XHTML et XML est très facile. Entourez simplement le texte que vous souhaitez commenter avec les éléments suivants:
et
Comme vous pouvez le constater, ces commentaires commencent par un "symbole inférieur à", plus un point d'exclamation et deux tirets. Le commentaire se termine par deux autres tirets et un symbole "supérieur à: symbole. Entre ces caractères, vous pouvez écrire ce que vous voulez pour former le corps du commentaire.
En CSS, c'est un peu différent, utiliser des commentaires de code C plutôt que HTML. Vous commencez par une barre oblique suivie d'un astérisque. Vous terminez le commentaire par l'inverse de celui-ci, un astérisque suivi d'une barre oblique.
Les commentaires sont un art mourant
La plupart des programmeurs connaissent la valeur des commentaires utiles. Le code commenté facilite le transfert de ce code d'un membre de l'équipe à un autre. Les commentaires aident l’équipe d’assurance qualité à tester le code car elle peut dire ce que le développeur avait prévu - même si cela n’a pas été réalisé. Malheureusement, avec la popularité des plates-formes de création de sites Web telles que Wordpress, qui vous permettent de vous lancer avec un thème choisi qui gère une grande partie, sinon la totalité, du code HTML, les commentaires ne sont pas utilisés aussi souvent par les équipes Web. En effet, il est très difficile de voir les commentaires dans la plupart des outils de création visuels si vous ne travaillez pas directement avec le code. Par exemple, plutôt que de voir, en haut d'une page Web:
L'outil visuel affiche une petite icône pour indiquer qu'un commentaire est présent. Si le concepteur n'ouvre pas physiquement le commentaire, il risque de ne jamais le voir. Et dans le cas de la page ci-dessus, cela pourrait poser problème si elle la modifie et que cette modification est écrasée par le script mentionné dans le commentaire.
Ce qui peut être fait?
- Écrivez des commentaires significatifs et utiles. Ne vous attendez pas à ce que d'autres personnes lisent vos commentaires s'ils sont trop longs ou n'incluent pas d'informations utiles.
- En tant que développeur, vous devriez toujours examinez les commentaires que vous voyez sur une page.
- Utilisez les outils fournis par les programmes de création qui vous permettent d’ajouter des commentaires.
- Utilisez la gestion de contenu pour contrôler le mode de modification des pages.
Même si vous êtes la seule personne à modifier vos pages Web, les commentaires peuvent être utiles. Si vous modifiez une page complexe une fois par an, il est facile d’oublier comment vous avez construit le tableau ou mis en place le CSS. Avec les commentaires, vous ne devez pas vous souvenir, car c'est écrit juste pour vous.
