Les commentaires HTML sont des sections de texte à l’intérieur des documents HTML qui sont ignorées par le navigateur et ne s’affichent donc pas sur le site Web. Ils servent à rendre le code plus compréhensible pour les développeurs, à laisser des remarques et à désactiver temporairement certains passages du code.

Hébergement Web
Hébergement Web de pointe au meilleur prix
  • 3x plus rapide, 60 % d'économie
  • Haute disponibilité >99,99 %
  • Seulement chez IONOS : jusqu'à 500 Go inclus

Que sont les commentaires HTML et comment en insérer ?

Un commentaire HTML est un marquage spécial qui permet aux programmeurs de laisser une sorte de note dans le code. Ces notes ne sont pas prises en compte par les navigateurs Web et sont donc invisibles pour les utilisateurs finaux. Pour créer un commentaire en HTML, on utilise la syntaxe <!-- Contenu du commentaire -->. Vous trouverez ci-dessous un exemple simple qui montre comment insérer un commentaire dans un document HTML :

<!DOCTYPE html>
<html lang="fr">
<head>
    <meta charset="UTF-8">
    <title>Page d’exemple</title>
</head>
<body>
    <!-- Ceci est un commentaire. Il ne sera pas affiché dans le navigateur -->
    <h1>Titre H1</h1>
    <!-- <p>Ce texte ne s’affiche pas dans le navigateur.</p> -->
</body>
</html>
HTML

Dans l’exemple ci-dessus, le premier commentaire et celui autour du paragraphe HTML sont ignorés par le navigateur, de sorte que seul le texte à l’intérieur du titre HTML est affiché.

Notez qu’en HTML, il n’existe aucune syntaxe spécifique pour les commentaires multilignes. On peut toutefois simplement utiliser plusieurs lignes dans un seul commentaire. C’est particulièrement utile lorsque des explications ou des notes plus longues sont nécessaires. Les commentaires multilignes commencent et se terminent comme les commentaires à une seule ligne, le texte entre les deux peut comporter autant de lignes que nécessaire.

Note

Les commentaires sont l’une des premières choses que vous rencontrerez lorsque vous apprendrez le HTML. Pour en savoir plus sur les autres points à prendre en compte lorsque vous souhaitez programmer des sites Web en HTML, consultez notre grand tutoriel HTML d’introduction.

Pourquoi a-t-on besoin des commentaires HTML ?

Les commentaires HTML sont un outil essentiel dans le développement Web. Ils ont plusieurs fonctions importantes :

  • Documenter : les commentaires aident à documenter le code afin que d’autres développeurs ou le futur soi-même puissent comprendre plus facilement le but et le fonctionnement de certaines sections de code.
  • Désactiver le code : les programmeurs peuvent désactiver temporairement des parties de code ou des balises HTML sans avoir à les supprimer. Ceci est particulièrement utile lors de la recherche d’erreurs, du débogage ou de l’expérimentation.
  • Être organisé : les grands documents HTML peuvent être structurés et organisés grâce à l’utilisation de commentaires HTML. Cela facilite la navigation et l’édition du code.
  • Annoter : les développeurs peuvent, si nécessaire, laisser des notes personnelles dans le code.

Remarques importantes sur l’utilisation des commentaires HTML

Lors de l’utilisation d’un commentaire HTML, les programmeurs doivent tenir compte de certaines choses. En particulier, aucun commentaire imbriqué n’est possible. Cela signifie qu’un commentaire ne peut pas être placé à l’intérieur d’un autre commentaire. Cela entraînerait une erreur. L’exemple suivant illustre ce point :

<!--
    Ceci est un commentaire.
    <!-- Ceci est un commentaire imbriqué et provoque une erreur. -->
-->
HTML

Lors de la rédaction de commentaires, il convient également de respecter certaines bonnes pratiques. En premier lieu, les commentaires doivent être clairs et concis afin d’améliorer la lisibilité du code ; les longs commentaires peuvent en effet rendre le code confus. Les commentaires superflus doivent être évités. De plus, dans le meilleur des cas, le code s’explique de lui-même. Les commentaires sont un complément utile, mais ne remplacent pas un style de programmation propre.

Nom de domaine
Votre domaine en un clic
  • 1 certificat SSL Wildcard par contrat
  • Fonction incluse Domain Connect pour une configuration DNS simplifiée
Cet article vous a-t-il été utile ?
Aller au menu principal