Die gebräuchliche Schreibweise ist ein HTML-Kommentar
Setze den Hinweis zwischen `<!--` und `-->`. Ein Renderer mit Unterstützung für rohe HTML-Kommentare nimmt den Text nicht in die sichtbare Ausgabe auf.
Es handelt sich um HTML innerhalb der Markdown-Datei. Eine Plattform darf rohes HTML abschalten, maskieren oder beim Export entfernen.
# Projektstatus
<!-- Vor Veröffentlichung die Zahl prüfen. -->
Die nächste Version ist freigegeben.Projektstatus
Die nächste Version ist freigegeben.| Aufgabe | Schreibweise | Grenze |
|---|---|---|
| Redaktionshinweis | <!-- Hinweis --> | Ziel muss rohe HTML-Kommentare erlauben |
| Notiz nur für Obsidian | %% Hinweis %% | Nicht allgemein portabel |
| Vertrauliche Information | Nicht in die Datei schreiben | Unsichtbar ist nicht geschützt |
| Syntax als Beispiel zeigen | Codeblock | Zeichen bleiben sichtbar |
Ein ausgeblendeter Kommentar bleibt auffindbar
Der Text steht weiterhin in der Markdown-Datei. Wer den Rohtext, die Versionsgeschichte oder einen Download öffnet, kann ihn lesen.
Unproblematisch sind Hinweise wie „Screenshot ersetzen“ oder „Quelle der Zahl prüfen“. Zugangsdaten, interne Kundendaten und noch vertrauliche Ergebnisse gehören nicht hinein.
- Kommentare ersetzen keine Berechtigungen.
- Öffentliche Repository-Kommentare sind als öffentlich zu behandeln.
- Erledigte Hinweise sollten aus dem Dokument entfernt werden.
- Versehentlich eingecheckte Geheimnisse müssen auch in der Historie bereinigt werden.
Kurze und mehrzeilige Kommentare
Eine kurze Erinnerung passt in eine Zeile. Für eine Prüfliste kann der Kommentar über mehrere Zeilen laufen.
Achte besonders auf das schließende `-->`. Fehlt es, kann nachfolgender Inhalt Teil des HTML-Blocks werden und unerwartet aus der Ausgabe verschwinden.
<!--
Vor dem Release:
- Links testen
- Summen prüfen
- Alt-Texte ergänzen
-->Die Liste bleibt in der Quelldatei, erscheint aber nicht als gerenderter Inhalt.GitHub blendet den Hinweis nur in der gerenderten Ansicht aus
GitHub dokumentiert HTML-Kommentare ausdrücklich zum Ausblenden von gerendertem Markdown. Über die Codeansicht bleibt der Kommentar im README sichtbar.
Für Pflegehinweise an Mitwirkende ist das sinnvoll. In einem öffentlichen Repository darf der Kommentar trotzdem nichts enthalten, was Besucher nicht erfahren sollen.
## Installation
<!-- Befehl nach Paketänderungen aktualisieren. -->
```sh
npm install
```Im gerenderten README unsichtbar, in der Codeansicht lesbar.`%%` ist eine Obsidian-Erweiterung
Obsidian kann Text zwischen `%%` als Inline- oder Blockkommentar behandeln. In der Leseansicht wird er ausgeblendet, während er beim Bearbeiten erreichbar bleibt.
Andere Markdown-Anwendungen müssen diese Syntax nicht verstehen. Soll die Datei zwischen Obsidian, GitHub und einem CMS wechseln, ist der HTML-Kommentar meist die portablere Ausgangsbasis.
Der Entwurf ist fertig. %%Budget noch einmal prüfen.%%Prozentzeichen und Notiz können als normaler Text erscheinen.Im Codeblock werden Kommentarzeichen absichtlich gezeigt
Ein eingezäunter Codeblock bewahrt die Zeichen wörtlich. Ein HTML-Kommentar darin wird als Codebeispiel angezeigt und nicht als unsichtbare Markdown-Notiz verarbeitet.
Die Sprachangabe `html` steuert nur die Hervorhebung. Sie ändert nicht die Auswertungsregeln innerhalb des Blocks.
```html
<!-- Dieser Hinweis wird als Code gezeigt. -->
<p>Beispiel</p>
```Ein sichtbarer HTML-Codeblock mit Kommentarzeichen.Renderer, Sanitizer und Exporte verhalten sich unterschiedlich
CommonMark beschreibt HTML-Kommentare als rohes HTML. Ein Produkt kann dieses HTML aus Sicherheitsgründen trotzdem deaktivieren oder bereinigen. Auch ein Export nach HTML, DOCX oder PDF kann Kommentare verwerfen.
Prüfe deshalb nicht nur eine beliebige Vorschau, sondern die tatsächliche Zielplattform und das erzeugte Endformat.
| Beobachtung | Mögliche Ursache | Prüfung |
|---|---|---|
| Kommentar ist nicht sichtbar | Als HTML-Kommentar erkannt | Rohdatei öffnen |
| Marker erscheinen im Text | Rohes HTML deaktiviert | Einstellungen des Ziels prüfen |
| Nachfolgender Text fehlt | Schließendes `-->` fehlt | Markerpaare kontrollieren |
| Kommentar fehlt im Export | Sanitizer hat ihn entfernt | Quelle und Ausgabe vergleichen |
Eine saubere Redaktionsroutine
Kommentare sollen den nächsten Arbeitsschritt erklären, nicht dauerhaft Altlasten sammeln. Halte sie knapp, unverfänglich und überprüfbar.
- Ziel festlegenBestimme, ob GitHub, Obsidian, ein CMS oder ein anderer Renderer maßgeblich ist.
- Nur unkritische Hinweise notierenSchreibe so, als könne jede Person mit Dateizugriff den Kommentar lesen.
- Quelle und Ausgabe öffnenKontrolliere Vorschau, Rohtext und heruntergeladene Datei.
- Erledigte Kommentare löschenBewahre nur Kontext auf, der späteren Bearbeitenden wirklich hilft.
Passende Werkzeuge
Häufige Fragen
Wie lautet die Kommentar-Syntax in Markdown?
Markdown hat kein eigenes universelles Kommentarzeichen. Wenn rohes HTML erlaubt ist, kannst du `<!-- Kommentar -->` verwenden.
Sind Markdown-Kommentare vertraulich?
Nein. Sie können in der Ansicht unsichtbar sein und trotzdem in Datei, Repository-Verlauf oder Download lesbar bleiben.
Funktionieren HTML-Kommentare in GitHub-READMEs?
Ja. GitHub blendet sie in der gerenderten Ansicht aus; in der Codeansicht bleiben sie sichtbar.
Was bedeutet `%% Kommentar %%`?
Das ist Obsidian-spezifische Syntax. Andere Markdown-Renderer können sie als normalen Text anzeigen.
Kann ein Kommentar über mehrere Zeilen gehen?
Ja. Umschließe die Zeilen mit `<!--` und `-->` und prüfe anschließend den Abschlussmarker.
Warum wird mein Kommentar angezeigt?
Das Ziel blockiert möglicherweise rohes HTML oder der Marker steht in einem Codeblock. Teste die Datei im endgültigen Renderer.
Darf ein API-Schlüssel in einen Kommentar?
Nein. Ein Kommentar ist keine Verschlüsselung und schützt keine vertraulichen Daten.