Markdown -kommentar
Markdown er plattformuavhengig og kan transporteres i praktisk talt alle applikasjoner. Som et resultat har det fått omfattende bruk i nettutvikling som blogger, dokumenter, notatbøker, e -post og etc.
Hvordan fungerer Markdown?
Som nevnt er Markdown et markeringsspråk. Derfor jobber du i en fil som slutter .MD eller .Markdown Extension. Denne filen inneholder formateringselementer som overskrifter, kodeblokker, innrykk, justeringer og etc.
Markdown -dokumentet behandles av en applikasjon kjent som en markdown -prosessor eller analyser. Parseren tar deretter den formaterte teksten og produserer dokumentet HTML. Du kan deretter se HTML -dokumentet i en nettleser eller hvilken som helst applikasjon som støtter det.
Bildet nedenfor illustrerer hvordan denne prosessen fungerer.
(Dette bildet er form markdown -guide.)
Du kan lære mer om hvordan Markdown fungerer i ressursen nedenfor:
https: // www.Markdownguide.org/
Hva er en Markdown -kommentar?
En Markdown -kommentar refererer til en tekst som er lagt til en Markdown -fil, men ignorert av Renderer -appen. Dermed vises en markdown -kommentar ikke i den genererte utgangen.
Kommentarer er nyttige når du trenger å ta med skjult tekst i dokumentet ditt som bare er synlig for dokumentets forfatter, men ikke utsatt for det resulterende dokumentet.
Hvordan du setter inn Markdown -kommentarer
Dessverre gir Markdown ikke innfødt støtte for kommentarer. Du kan imidlertid bruke importerte løsninger for å legge til kommentarer til markdokumentet ditt.
Metode 1
Den første syntaksen for å legge til en kommentar i Markdown er å plassere kommentarteksten din i et par firkantede parenteser, etterfulgt av en tykktarm, et rom og et pundskilt.
Syntaksen er som vist:
[kommentar_text]: #
Teksten inne i de firkantede parentesene blir behandlet som en kommentar og ignorert av markdown -gjengivelsen.
Et eksempel er som vist:
## Markdown Kommentar illustrasjon
Dette er et avsnitt
[Dette er en kommentar]: #
Kommentaren over er ikke synlig.
I eksemplet over har vi en enkel markdown -syntaks med en overskrift, et avsnitt, en kommentar og et annet avsnitt.
Metode 2
Syntaksen nedenfor kan også sette inn kommentarer i et Markdown -dokument.
[//]: # (kommentartekst går her)
Dette blir sett på som det mest plattformkompatible formatet for å legge til kommentarer.
En annen variant av denne syntaksen er:
[//]: # "Kommentartekst går her"
Metode 3
I noen Markdown -motorer kan du hoppe over de to fremoverstrøkene og bruke syntaksen nedenfor:
[]: # (kommentartekst)
eller
[]: # "Kommentartekst"
eller
[]: # 'kommentartekst'
Metode 4
Du kan også inkludere HTML -kommentarer i Markdown som illustrert i syntaksen nedenfor:
Populære Markdown -apper støtter metoden ovenfor.
Metode 5
Github lar deg også bruke syntaksen nedenfor for å betegne kommentarer:
:: kommentar
Kommentar tekst
:/kommentar
Skjønt, syntaks ovenfor er at den ikke er konvensjonelt adoptert og brukt.
Lukking
I denne opplæringen oppdaget du fem effektive metoder for å legge til kommentarer til din Markdown -kommentar.