Comment ajouter des commentaires en markdown ?

2024-09-02

Version courte

Markdown ne prend pas en charge les commentaires nativement. Utilisez plutôt des commentaires HTML.

<!-- Ceci est un commentaire -->

Version longue

Introduction

Bien que Markdown soit parfait pour créer du texte formaté, il n’a pas de fonction de commentaire intégrée. Cependant, vous pouvez toujours ajouter des commentaires en utilisant des éléments de commentaire HTML.

Ajout de commentaires dans Markdown

Pour ajouter des commentaires dans votre fichier Markdown, utilisez simplement la syntaxe de commentaire HTML. Tout ce qui est écrit à l’intérieur de  sera ignoré lors du rendu :

<!-- Ce commentaire n’apparaîtra pas dans la sortie -->

Vous pouvez ajouter des commentaires n’importe où dans votre document sans affecter le contenu de sortie.

Conclusion

Pour ajouter des commentaires dans Markdown, l'utilisation de commentaires HTML reste la meilleure approche. Ainsi, vous pouvez inclure des notes et des explications dans votre Markdown brut qui n'apparaîtront pas dans le document final.