<!-- … -->
Un commentaire dans le code HTML : une note pour les humains que le navigateur n’affiche pas, bien que chacun puisse la voir dans le code source de la page.
- Affichage
- none (non affiché)
- Contenu autorisé
- N’importe quel texte, y compris sur plusieurs lignes, sans les séquences
-->,--!>et<!--
Exemple
#<!-- Leçon 4, contenu corrigé le 12 septembre -->
<h2>Leçon 4 : les listes en HTML</h2>
<p>Vous créez une liste numérotée avec la balise <ol> et une liste à puces avec la balise <ul>.</p>
<!--
<p>Devoir : faire une liste de courses pour le week-end.</p>
<button type="button">Vérifier la solution</button>
-->
<p>Dans la prochaine leçon, nous aborderons les tableaux.</p>L’aperçu n’affiche que le titre et deux paragraphes. L’exercice mis en commentaire, avec le bouton, est toujours dans le code et reviendra sur la page quand vous retirerez <!-- et -->.
Définition et utilisation
#Un commentaire commence par <!-- et se termine par -->. Tout ce qui se trouve entre les deux est ignoré par le navigateur à l’affichage de la page, balises comprises. Un commentaire peut occuper une ligne ou plusieurs et peut se placer presque n’importe où dans le document, même avant la balise <html> et après </html>. Vous ne pouvez simplement pas en insérer à l’intérieur d’une balise, par exemple entre des attributs.
On utilise les commentaires de deux façons. La première, ce sont les notes pour soi et pour l’équipe : expliquer un passage peu évident, marquer le début et la fin d’une grande section, rappeler un point à corriger. La seconde, c’est la mise en commentaire, c’est-à-dire la désactivation temporaire d’un fragment de code sans le supprimer. Dans VS Code, vous le faites avec le raccourci Ctrl + / (Cmd + / sur Mac).
Un commentaire se termine au premier --> rencontré. C’est pourquoi les commentaires ne peuvent pas être imbriqués : le reste du commentaire extérieur apparaît sur la page comme du texte ordinaire. Pour la même raison, le texte d’un commentaire ne peut contenir ni --> ni <!--. L’absence de --> fermant est encore plus dangereuse, car le commentaire avale alors tout le reste de la page. Dans les éléments <style> et <script>, ce sont les commentaires CSS (/* … */) et JavaScript (// …) qui s’appliquent, et dans <textarea> et <title>, l’écriture <!-- … --> s’affiche telle quelle.
N’oubliez pas que les commentaires sont publics. Le navigateur ne les affiche pas, mais chacun peut les voir dans le code source de la page (par exemple avec le raccourci Ctrl + U) et dans les outils de développement, donc n’y laissez ni mots de passe, ni clés d’API, ni notes que vous ne voulez pas montrer au monde entier. Les commentaires conditionnels d’Internet Explorer, par exemple <!--[if IE]> … <![endif]-->, ont aussi été populaires. Les navigateurs modernes les traitent comme de simples commentaires, et Internet Explorer lui-même a cessé de les comprendre à la version 10, si bien qu’aujourd’hui, vous les croiserez surtout dans les modèles d’e-mails pour l’Outlook classique sous Windows.
Syntaxe
#<!-- Texte du commentaire -->
<!--
Un commentaire
sur plusieurs lignes
-->Plus d’exemples
#<!-- Ancienne grille tarifaire, à supprimer
<!-- Offre Pro, prix à définir -->
<p>Offre Pro : 49 € par mois</p>
-->
<p>Offre de base : 0 €</p>Le commentaire extérieur se termine déjà au premier -->, juste après les mots « prix à définir ». C’est pourquoi le paragraphe de l’offre Pro et le --> final s’affichent sur la page, alors qu’ils devaient être masqués.
<!--[if IE]>
<p>Vous utilisez Internet Explorer. Mettez à jour votre navigateur pour suivre le cours.</p>
<![endif]-->
<p>Ce paragraphe est visible dans tous les navigateurs.</p>Pour un navigateur moderne, tout le bloc de <!--[if IE]> à <![endif]--> est un seul commentaire ordinaire, donc l’aperçu n’affiche que le second paragraphe.
Compatibilité des navigateurs
#Largement disponible
Fonctionne dans tous les navigateurs modernes, y compris sur mobile. Vous pouvez l’utiliser sans crainte.
- Chrome
- Edge
- Firefox
- Safari
Bonnes pratiques
#- Commentez ce qui ne se voit pas dans le code lui-même, c’est-à-dire pourquoi on a fait les choses ainsi et pas autrement. Un commentaire « paragraphe » au-dessus d’un élément
<p>n’apporte rien. - Gardez le fragment de HTML qu’un script doit insérer plus tard dans la page dans un
<template>, et non dans un commentaire. Le navigateur comprend le contenu d’un modèle comme du HTML, un script peut donc facilement le copier. - En JSX, c’est-à-dire dans les composants React, les commentaires HTML ne fonctionnent pas. On y écrit
{/* commentaire */}.
Entrées associées
#- <!DOCTYPE html>La déclaration du type de document sur la première ligne du fichier. Elle indique au navigateur d’afficher la page en mode standard plutôt qu’en mode de compatibilité.
- <template>Un modèle HTML invisible qu’un script copie et insère dans la page.
- <style>Une feuille de style CSS écrite directement dans le document HTML.
- <script>Intègre du code JavaScript dans la page ou le charge depuis un fichier pour donner du comportement à la page.
- <html>La racine d’un document HTML. Tous les autres éléments de la page se trouvent à l’intérieur.
Vous voyez une erreur ou il manque un exemple ? Écrivez-nous.