Komentarz Markdown
Markdown jest niezależny od platformy i może być transportowany w praktycznie dowolnej aplikacji. W rezultacie zyskał obszerne wykorzystanie tworzenia stron internetowych, takich jak blogi, dokumenty, notebooki, e -maile i itp.
Jak działa Markdown?
Jak wspomniano, Markdown jest językiem znaczników. Dlatego pracujesz w pliku kończącym .MD lub .Rozszerzenie Markdown. Ten plik zawiera elementy formatowania, takie jak nagłówki, bloki kodu, wgłębienia, wyrównania itp.
Dokument Markdown jest przetwarzany przez aplikację znaną jako procesor lub parser Markdown. Parser następnie przyjmuje sformatowany tekst i wyprodukuje dokument HTML. Następnie możesz wyświetlić dokument HTML w przeglądarce lub dowolnej aplikacji, która go obsługuje.
Poniższy obraz ilustruje, jak działa ten proces.
(Ten obraz jest formą Przewodnika Markdown.)
Możesz dowiedzieć się więcej o tym, jak Markdown działa w poniższym zasadzie:
https: // www.MarkDownGuide.org/
Co to jest komentarz Markdown?
Komentarz Markdown odnosi się do tekstu dodanego do pliku Markdown, ale zignorowany przez aplikację Renderer. Zatem komentarz Markdown nie jest wyświetlany w wygenerowanym wyjściu.
Komentarze są pomocne, gdy musisz dołączyć ukryty tekst w dokumencie, który jest widoczny tylko dla autora dokumentu, ale nie jest ujawniany w wyniku uzyskanego dokumentu.
Jak wstawić komentarze Markdown
Niestety Markdown nie zapewnia natywnego wsparcia dla komentarzy. Możesz jednak użyć importowanych rozwiązań, aby dodać komentarze do dokumentu Markdown.
Metoda 1
Pierwszą składnią do dodania komentarza w Markdown jest umieszczenie tekstu komentarza do pary kwadratowych nawiasów, a następnie okrężnicy, przestrzeni i znaku funta.
Składnia jest jak pokazana:
[comment_text]: #
Tekst wewnątrz nawiasów kwadratowych jest traktowany jako komentarz i ignorowany przez Markdown Renderer.
Przykładem jest jak pokazano:
## Markdown komentarz ilustracja
To jest akapit
[To jest komentarz]: #
Powyższy komentarz nie jest widoczny.
W powyższym przykładzie mamy prostą składnię Markdown z nagłówkiem, akapitem, komentarzem i innym akapitem.
Metoda 2
Poniższa składnia może również wstawić komentarze do dokumentu Markdown.
[//]: # (tekst komentarza idzie tutaj)
Jest to uważane za najbardziej kompatybilny z platformy format do dodawania komentarzy.
Kolejną odmianą tej składni jest:
[//]: # „Tekst komentarza idzie tutaj”
Metoda 3
W niektórych silnikach Markdown możesz pominąć dwa cięcia do przodu i użyć składni poniżej:
[]: # (tekst komentarza)
Lub
[]: # „tekst komentarza”
Lub
[]: # '' tekst komentarza ''
Metoda 4
Możesz także dołączyć komentarze HTML w Markdown, jak pokazano w poniższej składni:
Popularne aplikacje Markdown obsługują powyższą metodę.
Metoda 5
GitHub pozwala również użyć poniższej składni, aby oznaczyć komentarze:
:: komentarz
tekst komentarza
:/komentarz
Chociaż powyższa składnia polega na tym, że nie jest ona konwencjonalnie przyjęta i używana.
Zamknięcie
W tym samouczku odkryłeś pięć skutecznych metod dodawania komentarzy do komentarza Markdown.