100 % privat — alles läuft in Ihrem Browser
Markdown Kommentar
Schreiben Sie <!-- eine Notiz --> ins Markdown: Sie bleibt in der Quelle und verschwindet von der Seite. Bearbeiten Sie versteckte Markdown-Kommentar-Beispiele live.
MD Viewer-Team
Visible text
Ein Markdown Kommentar ist ein zweckentfremdeter HTML-Kommentar: Sie schreiben <!-- Ihre Notiz --> in die Quelle, und Renderer verstecken ihn vor der fertigen Seite, während er in der Datei bleibt. Der Spielplatz oben zeigt beide Hälften dieses Verhaltens nebeneinander — der Quellbereich enthält den Markdown Kommentar, der Vorschaubereich nicht. Bearbeiten Sie den Text zwischen den Markern und sehen Sie zu, wie sich die versteckte Notiz ändert, ohne jemals im gerenderten Ergebnis aufzutauchen.
Ein Markdown Kommentar dient allem, was eine Datei braucht, eine Seite aber nicht zeigen darf: Review-Notizen, TODOs, Anweisungen für künftige Bearbeiter, während einer Überarbeitung auskommentierte Abschnitte oder Erinnerungen daran, welche Felder eine Vorlage akzeptiert. Weil der Markdown Kommentar reiner Text in der Datei ist, überlebt er Versionsverwaltung, Diffs, grep und Suche — eine Notiz an Mitarbeiter, nicht an den Renderer.
Zwei ehrliche Warnungen begleiten die Technik. Erstens ist ein Markdown Kommentar nicht privat: Jeder, der die Rohdatei oder den Seitenquelltext öffnet, sieht ihn — niemals Geheimnisse, Zugangsdaten oder unangekündigte Inhalte hineinlegen. Zweitens strippen Renderer, die alles HTML entfernen, auch den Kommentar — harmlos, aber die Notiz verschwindet früher als gedacht. Die Beispiele decken Block- und Inline-Form ab.
Syntax-Referenz für den Markdown Kommentar
| Sie tippen | Was passiert |
|---|---|
| <!-- Notiz --> | Ein Markdown Kommentar auf eigener Zeile — versteckt in der Vorschau |
| Text <!-- Notiz --> Text | Ein Inline-Kommentar, versteckt zwischen sichtbaren Wörtern |
| <!-- Zeile eins Zeile zwei --> | Ein mehrzeiliger Kommentar in der Quelle |
| <!-- **Entwurf** --> | Formatierung im Kommentar ist ebenfalls versteckt |
| <!-- (ohne schließenden Marker) | Kaputter Kommentar — der Rest der Datei kann verschwinden |
So schreiben Sie einen Markdown Kommentar
- 1
Mit <!-- öffnen
Setzen Sie den öffnenden Marker an den Beginn des versteckten Inhalts — an den Zeilenanfang für einen Block-Markdown-Kommentar oder mitten in den Satz für eine Inline-Notiz.
- 2
Notiz schreiben
Alles zwischen den Markern gehört zum Markdown Kommentar: Klartext, Markdown-Formatierung, ganze Entwurfsabsätze. Nichts davon wird gerendert.
- 3
Mit --> schließen
Der schließende Marker ist Pflicht. Ein nicht abgeschlossener Markdown Kommentar verschlingt jedes folgende Zeichen — der häufigste Weg, wie Kommentare eine Seite brechen.
- 4
Vorschau prüfen
Der Quellbereich zeigt Ihre Notiz weiter; die Vorschau zeigt sie verschwunden. Genau so verhält sich ein Markdown Kommentar in echten Dokumentations-Pipelines.
Wofür sich ein Markdown Kommentar eignet
Die stärkste Nutzung des Markdown Kommentars ist redaktionell: Anweisungen dort hinterlassen, wo sie gebraucht werden. Eine Vorlage kann über jedem Abschnitt <!-- API-Schlüssel-Feld unten ausfüllen --> tragen; ein Changelog hält <!-- Eintrag entworfen, wartet auf Freigabe --> neben einem unveröffentlichten Punkt; ein langes README kommentiert einen veralteten Abschnitt aus, statt die Geschichte zu löschen. Der Text bleibt in der Datei: git blame ordnet ihn zu, und künftige Bearbeiter löschen einfach die Marker, um den Inhalt wiederherzustellen.
Die zweite Familie ist strukturell. Einen defekten Codezaun während des Debuggens auskommentieren, eine Entwurfstabelle bis zur Bestätigung der Zahlen verstecken oder markieren, wo ein generiertes Inhaltsverzeichnis eingefügt wird — alles natürliche Aufgaben für einen Markdown Kommentar. Was ein Kommentar nie sein darf, ist ein Sicherheitsmechanismus: Der Inhalt reist in der öffentlichen Datei mit; behandeln Sie jeden Markdown Kommentar als veröffentlichten Text, der nur höflich genug ist, sich nicht zu rendern.
Im geteilten Repository gilt: Ein Markdown Kommentar ist eine Nachricht an die nächste bearbeitende Person — datieren, initialisieren, sagen, was als Nächstes passieren soll. <!-- TODO(mia): Preis vor Q3-Launch bestätigen --> überlebt <!-- prüfen --> um ein Jahr. Ist die Aufgabe erledigt, löschen Sie den ganzen Markdown Kommentar statt ihn zum Grabstein umzuschreiben — Geschichte gehört in die Versionsverwaltung, nicht in Kommentar-Sedimente.
Zuletzt ein Blick über den Tellerrand: Einige Static-Site-Generatoren interpretieren spezielle Kommentarformate als Build-Anweisungen — zum Beispiel <!-- more --> als Trennmarke für Teaser. Ein solcher Markdown Kommentar ist dann kein toter Text, sondern aktive Konfiguration. Wer fremde Themes oder Vorlagen nutzt, prüft deren Dokumentation, bevor er Kommentare blind löscht oder ergänzt.
Fehler beim Markdown Kommentar
<!-- nicht geschlossene Notiz
<!-- geschlossene Notiz -->
Ein Kommentar ohne Ende versteckt alles danach — manchmal die ganze restliche Datei. Schließen Sie jeden Markdown Kommentar.
<!--> heimtückischer Marker -->
<!-- schlichte Notiz -->
Ein > direkt nach <!-- schließt den Kommentar sofort und lässt den Rest als sichtbaren Text entweichen. Halten Sie ein Leerzeichen nach dem Öffner.
API-Schlüssel im Kommentar
Geheimnisse gar nicht erst in Markdown
Ein Markdown Kommentar ist für jeden sichtbar, der die Rohdatei liest. Behandeln Sie ihn nie als Verschlüsselung oder Zugriffskontrolle.
Kommentare bleiben in Ihrer heruntergeladenen Datei
Kopieren oder Herunterladen auf dieser Seite bewahrt den Markdown Kommentar Byte für Byte. Nur die gerenderte Ausgabe versteckt ihn — die gespeicherte Datei ist identisch mit der geöffneten.
Häufige Fragen
Quellen und Spec-Zitate
“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.”