Wie füge ich Kommentare in Markdown hinzu?

2024-09-02

Kurze Version

Markdown unterstützt nativ keine Kommentare. Verwenden Sie stattdessen HTML-Kommentare.

<!-- Dies ist ein Kommentar -->

Lange Version

Einführung

Obwohl Markdown perfekt für die Erstellung von formatiertem Text ist, verfügt es nicht über eine integrierte Kommentarfunktion. Sie können jedoch dennoch Kommentare hinzufügen, indem Sie HTML-Kommentar-Elemente verwenden.

Kommentare in Markdown hinzufügen

Um Kommentare in Ihrer Markdown-Datei hinzuzufügen, verwenden Sie einfach die HTML-Kommentarsyntax. Alles, was zwischen  steht, wird beim Rendern ignoriert:

<!-- Dieser Kommentar wird nicht im Output angezeigt -->

Sie können Kommentare überall in Ihrem Dokument hinzufügen, ohne den Inhaltsoutput zu beeinträchtigen.

Fazit

Um Kommentare in Markdown hinzuzufügen, bleibt die Verwendung von HTML-Kommentaren der beste Ansatz. Auf diese Weise können Sie Notizen und Erklärungen in Ihrem Roh-Markdown einfügen, die im endgültigen Dokument nicht erscheinen.