100 % privé — tout s'exécute dans votre navigateur
Commentaire Markdown
Écrivez <!-- une note --> dans votre Markdown : elle reste dans la source et disparaît de la page. Éditez des exemples de commentaire Markdown cachés, en direct.
Équipe MD Viewer
Visible text
Un commentaire Markdown est un commentaire HTML détourné : vous écrivez <!-- votre note --> dans la source, et les moteurs le cachent de la page finale tout en le gardant dans le fichier. Le terrain de jeu ci-dessus montre les deux moitiés de ce comportement côte à côte — le panneau source contient le commentaire Markdown, le panneau aperçu non. Modifiez le texte entre les marqueurs et regardez-le changer sans jamais apparaître dans le rendu.
On utilise un commentaire Markdown pour ce dont un fichier a besoin mais qu'une page ne doit pas montrer : notes de relecture, TODO, consignes aux futurs éditeurs, sections commentées pendant une réécriture, ou rappels comme les champs acceptés par un gabarit. Comme le commentaire Markdown est du texte brut dans le fichier, il survit au contrôle de version, aux diffs, à grep — c'est une note aux collaborateurs, pas au moteur.
Deux mises en garde honnêtes accompagnent la technique. D'abord, un commentaire Markdown n'est pas privé : quiconque ouvre le fichier brut ou la source de la page le voit — n'y mettez jamais de secrets, d'identifiants ou d'annonces non publiées. Ensuite, les moteurs qui filtrent tout le HTML filtreront le commentaire avec : sans gravité, mais la note disparaît plus tôt que prévu. Les exemples couvrent les formes bloc et en ligne.
Chaque exemple de commentaire Markdown de cette page est éditable : modifiez la note, regardez la source changer et l'aperçu rester identique — la démonstration vaut mieux que la théorie.
Référence de la syntaxe de commentaire Markdown
| Vous tapez | Ce qui se passe |
|---|---|
| <!-- note --> | Un commentaire Markdown sur sa propre ligne — caché de l'aperçu |
| Texte <!-- note --> texte | Un commentaire en ligne caché entre des mots visibles |
| <!-- ligne un ligne deux --> | Un commentaire multi-lignes dans la source |
| <!-- **brouillon** --> | La mise en forme dans le commentaire est aussi cachée |
| <!-- (sans marqueur de fin) | Commentaire cassé — le reste du fichier peut disparaître |
Comment écrire un commentaire Markdown
- 1
Ouvrez avec <!--
Placez le marqueur d'ouverture au début du contenu caché — en début de ligne pour un commentaire Markdown en bloc, ou en pleine phrase pour une note en ligne.
- 2
Écrivez votre note
Tout ce qui se trouve entre les marqueurs appartient au commentaire Markdown : texte simple, mise en forme Markdown, même des paragraphes de brouillon. Rien ne se rend.
- 3
Fermez avec -->
Le marqueur de fermeture est obligatoire. Un commentaire Markdown non terminé avale tous les caractères suivants — c'est la façon la plus courante de casser une page.
- 4
Vérifiez l'aperçu
Le panneau source garde votre note visible ; l'aperçu la montre disparue. Cette vue divisée est exactement le comportement d'un commentaire Markdown dans les vraies chaînes de documentation.
À quoi sert un commentaire Markdown
L'usage le plus fort du commentaire Markdown est éditorial : laisser des consignes là où elles sont nécessaires. Un gabarit peut porter <!-- Renseignez la clé API ci-dessous --> au-dessus de chaque section ; un journal des modifications garde <!-- entrée rédigée, en attente de validation --> près d'un élément non publié ; un long README commente une section obsolète au lieu d'effacer l'histoire. Le texte reste dans le fichier : git blame l'attribue et les futurs éditeurs n'ont qu'à supprimer les marqueurs pour restaurer le contenu.
La seconde famille d'usages est structurelle. Commenter un bloc de code défectueux en déboguant la documentation, masquer un tableau de brouillon en attendant des chiffres confirmés, ou marquer l'endroit où une table des matières générée sera insérée — tous sont des tâches naturelles de commentaire Markdown. Ce qu'un commentaire ne doit jamais être, c'est un mécanisme de sécurité : le contenu voyage dans le fichier public, traitez donc chaque commentaire Markdown comme du texte publié qui a la politesse de ne pas s'afficher.
Dans un dépôt partagé, un commentaire Markdown est un message au prochain éditeur : datez-le, signez-le, dites ce qui doit suivre. <!-- TODO(mia): confirmer le prix avant le lancement T3 --> survivra un an à <!-- vérifier -->. La tâche faite ? Supprimez le commentaire Markdown entier plutôt que d'en faire une pierre tombale — l'histoire appartient au contrôle de version, pas aux sédiments de commentaires.
Erreurs de commentaire Markdown
<!-- note non fermée
<!-- note fermée -->
Un commentaire qui ne se ferme pas cache tout ce qui suit — parfois le reste entier du fichier. Fermez toujours le commentaire Markdown.
<!--> marqueur piégé -->
<!-- note simple -->
Placer > juste après <!-- referme le commentaire aussitôt et laisse fuir le reste en texte visible. Gardez une espace après le marqueur d'ouverture.
Stocker des clés d'API en commentaire
Ne jamais mettre de secrets en Markdown
Un commentaire Markdown est visible de quiconque lit le fichier brut. Ne le traitez jamais comme un chiffrement ou un contrôle d'accès.
Les commentaires restent dans votre fichier téléchargé
Copier ou télécharger depuis cette page préserve le commentaire Markdown octet par octet. Seul le rendu le cache — le fichier que vous enregistrez est identique au fichier ouvert.
Questions fréquentes
Sources et citations de spécification
“Comments must start with the four character sequence U+003C LESS-THAN SIGN, U+0021 EXCLAMATION MARK, U+002D HYPHEN-MINUS, U+002D HYPHEN-MINUS (<!--).”
“Raw HTML (and thus, HTML comments) is passed through unaltered — but the rendered output is the browser’s decision.”