Le balisage HTML correctement commenté est une partie importante d'une page Web bien construite. Ces commentaires sont faciles à ajouter et quiconque devra travailler sur le code de ce site à l'avenir (y compris vous-même ou les membres de l'équipe avec laquelle vous travaillez) vous remerciera de ces commentaires.
Comment ajouter des commentaires HTML
Le code HTML peut être créé avec un éditeur de texte standard, tel que Notepad ++ pour Windows ou TextEdit pour un Mac. Vous pouvez également utiliser un programme centré sur la conception Web tel qu'Adobe Dreamweaver ou même une plate-forme CMS telle que Wordpress ou ExpressionEngine. Quel que soit l'outil que vous utilisez pour créer du HTML, si vous travaillez directement avec le code, vous ajouterez des commentaires HTML comme ceci:
-
Ajoutez la première partie de la balise de commentaire HTML:
-
Au total, votre commentaire ressemblera à ceci:
-
C'est vraiment aussi simple que cela.
L'affichage des commentaires
Tous les commentaires que vous ajoutez à votre code HTML apparaîtront dans ce code si quelqu'un visualise la source de la page Web ou ouvre le code HTML dans un éditeur pour y apporter des modifications. Ce texte de commentaire n'apparaîtra cependant pas dans le navigateur Web lorsqu'un visiteur normal se rend sur le site. Contrairement aux autres éléments HTML, y compris les paragraphes, les en-têtes ou les listes, qui ont une incidence sur la page à l'intérieur de ces navigateurs, les commentaires sont vraiment des éléments "en coulisses" de la page.
Commentaires à des fins de test
Comme les commentaires n'apparaissent pas dans un navigateur Web, ils peuvent être utilisés pour "désactiver" certaines parties d'une page lors du test ou du développement de la page. Si vous ajoutez la partie d'ouverture d'un commentaire directement avant la partie de votre page / code que vous souhaitez masquer, puis que vous ajoutez la partie de fermeture à la fin de ce code (les commentaires HTML peuvent s'étendre sur plusieurs lignes, ce qui vous permet d'ouvrir un commentez la ligne 50 de votre code et fermez-la à la ligne 75 sans aucun problème), alors quels que soient les éléments HTML compris dans ce commentaire, ils ne seront plus affichés dans le navigateur. Ils resteront dans votre code, mais n'auront aucune incidence sur l'affichage visuel de la page. Si vous avez besoin de tester une page pour voir si une section pose problème, etc., il est préférable de la commenter que de la supprimer. Avec les commentaires, si la section de code en question s'avère ne pas être le problème, vous pouvez facilement supprimer les commentaires et ce code sera affiché à nouveau. Assurez-vous simplement que ces commentaires utilisés pour les tests ne sont pas intégrés aux sites Web de production.
Si une zone d'une page ne doit pas être affichée, vous souhaitez supprimer le code, et pas simplement le commenter, avant de lancer ce site.
Une bonne utilisation des commentaires HTML au cours du développement consiste à créer un site Web réactif. Étant donné que différentes parties de ce site changeront d’apparence en fonction de la taille de l’écran, y compris certaines zones qui pourraient ne pas être affichées du tout, l’utilisation de commentaires pour activer ou désactiver des sections d’une page peut être une astuce simple et rapide à utiliser pendant le développement.
Concernant la performance
J'ai vu des professionnels du Web suggérer que les commentaires soient supprimés des fichiers HTML et CSS afin de réduire la taille de ces fichiers et de créer des pages à chargement plus rapide. Bien que je convienne que les pages doivent être optimisées pour les performances et chargées rapidement, il reste néanmoins de la place pour une utilisation intelligente des commentaires dans le code. N'oubliez pas que ces commentaires ont pour but de faciliter le travail futur sur un site. Par conséquent, tant que vous ne le perdez pas, des commentaires ajoutés à chaque ligne de votre code permettent de limiter la petite quantité de fichier ajoutée à une page en raison de: les commentaires devraient être plus qu'acceptables.
Conseils d'utilisation des commentaires
Quelques éléments à prendre en compte ou à retenir lors de l’utilisation de commentaires HTML:
- Les commentaires peuvent être plusieurs lignes.
- Utilisez des commentaires pour documenter le développement de votre page.
- Les commentaires peuvent également documenter le contenu, les rangées ou les colonnes d'un tableau, suivre les modifications ou tout ce que vous souhaitez.
- Les commentaires qui "désactivent" les zones d'un site ne doivent pas être mis en production, sauf si cette modification est temporaire et sera inversée rapidement (comme si un message d'alerte était activé ou désactivé si nécessaire).
