Markdown -Kommentar
Markdown ist plattformunabhängig und kann in praktisch jeder Anwendung transportiert werden. Infolgedessen hat es in der Webentwicklung umfangreiche Verwendung wie Blogs, Dokumente, Notizbücher, E -Mails usw. gewonnen.
Wie funktioniert Markdown??
Wie bereits erwähnt, ist Markdown eine Markup -Sprache. Daher arbeiten Sie in einer Datei, die in endet .md oder .Markdown -Erweiterung. Diese Datei enthält Formatierungselemente wie Überschriften, Codeblöcke, Eindrücke, Ausrichtungen usw.
Das Markdown -Dokument wird von einer Anwendung verarbeitet, die als Markdown -Prozessor oder Parser bezeichnet wird. Der Parser übernimmt dann den formatierten Text und erstellt das Dokument HTML. Sie können dann das HTML -Dokument in einem Browser oder einer beliebigen Anwendung anzeigen, die es unterstützt.
Das Bild unten zeigt, wie dieser Prozess funktioniert.
(Dieses Bild ist Form Markdown -Handbuch.)
Sie können mehr darüber erfahren, wie Markdown in der folgenden Ressource funktioniert:
https: // www.Markdownguide.org/
Was ist ein Markdown -Kommentar?
Ein Markdown -Kommentar bezieht sich auf einen zu einer Markdown -Datei hinzugefügten Text, der jedoch von der Renderer -App ignoriert wird. Somit wird in der generierten Ausgabe kein Markdown -Kommentar angezeigt.
Kommentare sind hilfreich, wenn Sie versteckten Text in Ihr Dokument aufnehmen müssen, das nur für den Autor des Dokuments sichtbar ist, jedoch nicht dem resultierenden Dokument aufgedeckt wird.
So fügen Sie Markdown -Kommentare ein
Leider bietet Markdown keine native Unterstützung für Kommentare. Sie können jedoch importierte Lösungen verwenden, um Ihrem Markdown -Dokument Kommentare hinzuzufügen.
Methode 1
Die erste Syntax für das Hinzufügen eines Kommentars im Markdown ist die Platzierung Ihres Kommentartextes in ein Paar quadratische Klammern, gefolgt von einem Dickdarm, einem Raum und einem Pfundzeichen.
Die Syntax ist wie gezeigt:
[comment_text]: #
Der Text in den Quadratklammern wird als Kommentar behandelt und vom Markdown -Renderer ignoriert.
Ein Beispiel ist wie gezeigt:
## Markdown -Kommentarillustration
Dies ist ein Absatz
[Dies ist ein Kommentar]: #
Der obige Kommentar ist nicht sichtbar.
Im obigen Beispiel haben wir eine einfache Markdown -Syntax mit einer Überschrift, einem Absatz, einem Kommentar und einem anderen Absatz.
Methode 2
Die folgende Syntax kann auch Kommentare in ein Markdown -Dokument einfügen.
[//]: # (Kommentar Text geht hier)
Dies gilt als das am meisten plattformkompatible Format zum Hinzufügen von Kommentaren.
Eine weitere Variation dieser Syntax ist:
[//]: # "Kommentar Text geht hier"
Methode 3
In einigen Markdown -Motoren können Sie die beiden Vorwärts -Schrägstriche überspringen und die folgende Syntax verwenden:
[]: # (Kommentartext)
oder
[]: # "Kommentartext"
oder
[]: # 'Kommentar Text'
Methode 4
Sie können auch HTML -Kommentare in Markdown einfügen, wie in der folgenden Syntax dargestellt:
Beliebte Markdown -Apps unterstützen die obige Methode.
Methode 5
Mit GitHub können Sie auch die folgende Syntax verwenden, um Kommentare zu bezeichnen:
:: Kommentar
Kommentartext
:/Kommentar
Die obige Syntax ist zwar, dass sie nicht konventionell übernommen und verwendet wird.
Schließen
In diesem Tutorial haben Sie fünf effektive Methoden zum Hinzufügen von Kommentaren zu Ihrem Markdown -Kommentar entdeckt.