Commentaire HTML : masquer du contenu sans le rendre confidentiel

Pour écrire un commentaire HTML, placez votre texte entre <!-- et --> : <!-- Votre commentaire -->. Le navigateur ne l’affiche pas dans la page, mais il reste présent dans le code source. Cette syntaxe sert à expliquer le balisage, à masquer temporairement un bloc ou à isoler une erreur.
Écrire un premier commentaire et vérifier son effet
Un commentaire commence par une séquence d’ouverture, <!--, et se termine par une séquence de fermeture, -->. Le point d’exclamation apparaît uniquement à l’ouverture. Les espaces autour du texte ne sont pas obligatoires, mais ils facilitent la lecture.
Voici un exemple à copier dans un document HTML :
<!-- Présentation du service -->
Cette ligne ne produit aucun texte visible dans la page. Elle laisse simplement une indication à la personne qui consulte ou modifie le fichier. On parle souvent de « balise de commentaire », même si ces délimiteurs ne fonctionnent pas comme un élément classique possédant une balise ouvrante et une balise fermante.
Comparer le code et le résultat affiché
Pour observer la différence, placez un commentaire entre deux paragraphes. Le navigateur affiche les paragraphes, mais pas la note intermédiaire :
<p>Bienvenue sur notre site.</p>
<!-- Texte à relire avant publication -->
<p>Nos horaires sont indiqués ci-dessous.</p>
Le lecteur voit uniquement « Bienvenue sur notre site. » puis « Nos horaires sont indiqués ci-dessous. ». La remarque reste consultable dans le code source si elle est bien transmise au navigateur. Non affiché ne signifie donc ni supprimé ni confidentiel. N’inscrivez jamais de mot de passe, de clé privée ou d’information personnelle sensible dans un commentaire destiné à une page publique.
Masquer une ligne, un bloc ou quelques mots
La même syntaxe permet d’entourer du balisage plutôt qu’une simple note. Le contenu situé entre les délimiteurs n’est alors pas interprété comme des éléments à afficher. C’est pratique pendant une modification, à condition de conserver une structure cohérente autour du bloc désactivé.
Apprendre à utiliser les commentaires HTML : Découvrez comment ajouter des notes explicatives ou neutraliser temporairement des portions de code HTML sans les supprimer.
Commenter un élément ou plusieurs lignes
Pour retirer provisoirement un paragraphe du rendu sans l’effacer du fichier, encadrez l’élément entier :
<!-- <p>Offre temporairement indisponible.</p> -->
Pour plusieurs lignes, ouvrez le commentaire avant le premier élément concerné et fermez-le après le dernier. Il n’existe pas de délimiteur spécial pour les commentaires multilignes : les retours à la ligne ne changent pas leur fonctionnement.
<!--
<h2>Prochain événement</h2>
<p>Le programme sera annoncé prochainement.</p>
-->
Lors de la saisie dans votre éditeur, ces lignes peuvent rester dans un seul bloc. Le titre et le paragraphe ne seront pas affichés. Avant d’entourer une section entière, vérifiez toutefois qu’elle ne contient pas déjà un commentaire : les commentaires HTML ne s’imbriquent pas.
Masquer seulement une partie du texte
Un commentaire peut aussi se trouver à l’intérieur d’un paragraphe, entre deux portions de texte. Par exemple, <p>Livraison <!-- express -->disponible.</p> affiche « Livraison disponible. ». Surveillez les espaces : un commentaire ne les ajoute pas automatiquement. Retirer un mot peut donc coller les mots voisins si aucun espace n’est conservé.
Placez les commentaires entre des éléments ou dans leur contenu textuel, plutôt qu’au milieu d’une balise ouvrante. Insérer <!-- ... --> entre le nom d’une balise et ses attributs n’est pas une manière valide de désactiver un attribut.
Documenter les décisions et rechercher une erreur
Un commentaire utile explique une intention qui n’est pas évidente à la lecture du balisage. Écrire « début du paragraphe » devant un élément <p> apporte peu. Préciser qu’un texte doit conserver une formulation validée, ou qu’un bloc attend une traduction, donne en revanche une information exploitable.
Considérez chaque note comme le germe d’une intervention future : pour qu’elle aboutisse, elle doit contenir une action et une condition de résolution. « À revoir » laisse le prochain intervenant sans direction. « Remplacer ce texte dès validation des nouveaux horaires » indique quoi modifier et à quel moment. Cette petite discipline évite que les rappels deviennent une réserve de tâches oubliées.
| Usage | Contenu du commentaire | Effet sur la page |
|---|---|---|
| Documentation | Explication d’un choix de structure | Aucun contenu visible ajouté |
| Rappel | Modification à effectuer et condition de validation | Aucun contenu visible ajouté |
| Masquage temporaire | Éléments HTML mis en attente | Éléments concernés non affichés |
| Débogage | Bloc retiré pendant un test | Rendu modifié pour comparer |
Isoler un bloc sans multiplier les changements
Si une zone semble provoquer un problème d’affichage, commentez un ensemble cohérent, puis rechargez la page. Si le problème disparaît, vous avez une piste, pas encore une preuve : retirer un bloc peut aussi modifier l’organisation des éléments voisins.
- Conservez une version du code avant le test.
- Commentez un seul bloc, avec ses balises ouvrantes et fermantes.
- Comparez le rendu avant et après.
- Rétablissez le bloc, puis réduisez progressivement la zone examinée.
- Supprimez les commentaires de test lorsque le diagnostic est terminé.
Évitez de masquer uniquement une balise ouvrante tout en laissant sa fermeture active. Vous risqueriez de créer une structure déséquilibrée et de brouiller le diagnostic au lieu de le simplifier.
Respecter les délimiteurs et distinguer HTML de XML
Une fermeture oubliée peut englober davantage de contenu que prévu. Si une partie de la page disparaît après une modification, vérifiez d’abord les séquences d’ouverture et de fermeture. Vérifiez aussi que le bloc commenté ne contient pas un autre commentaire susceptible de fermer prématurément le premier.
MDN précise plusieurs contraintes sur le texte situé entre les délimiteurs :
- Il ne doit pas commencer par > ni par ->.
- Il ne doit pas contenir --> ni --!>.
- Il ne doit pas se terminer par <!-.
- La séquence <! est, en revanche, autorisée.
En pratique, utilisez des phrases simples et évitez de reproduire des délimiteurs de commentaire dans la note elle-même. Pour désactiver un bloc contenant déjà des commentaires, retirez temporairement ses commentaires internes ou utilisez une autre méthode de test plutôt que de tenter une imbrication.
La restriction supplémentaire en XML
Les commentaires XML emploient les mêmes délimiteurs, mais leurs contraintes ne sont pas identiques à celles de HTML. MDN rappelle notamment qu’un commentaire XML ne peut pas contenir la séquence --. Cette distinction concerne entre autres les documents SVG ou MathML traités comme du XML ; elle ne doit pas être confondue avec les règles d’un document HTML.
Enfin, le langage dans lequel vous écrivez reste déterminant : à l’intérieur de JavaScript ou de CSS, utilisez la syntaxe de commentaire propre à ce langage. Les délimiteurs HTML ne constituent pas une méthode universelle pour commenter n’importe quel code présent dans une page.