Commento di markdown
Markdown è indipendente dalla piattaforma e può essere trasportato praticamente in qualsiasi applicazione. Di conseguenza, ha ottenuto un ampio utilizzo nello sviluppo web come blog, documenti, quaderni, e -mail e ecc.
Come funziona Markdown?
Come accennato, Markdown è una lingua di markup. Pertanto, lavori in un file che termina .md o .Estensione di markdown. Questo file contiene elementi di formattazione come intestazioni, blocchi di codice, rientranze, allineamenti e ecc.
Il documento Markdown viene elaborato da un'applicazione nota come processore o parser Markdown. Il parser prende quindi il testo formattato e produce il documento HTML. È quindi possibile visualizzare il documento HTML in un browser o in qualsiasi applicazione che lo supporta.
L'immagine seguente illustra come funziona questo processo.
(Questa immagine è la guida di markdown del modulo.)
Puoi saperne di più su come funziona Markdown nella risorsa seguente:
https: // www.MarkdownGuide.org/
Cos'è un commento di markdown?
Un commento di markdown si riferisce a un testo aggiunto a un file di markdown ma ignorato dall'app rendering. Pertanto, un commento di markdown non viene visualizzato nell'output generato.
I commenti sono utili quando è necessario includere il testo nascosto nel documento che è visibile solo all'autore del documento ma non esposto sul documento risultante.
Come inserire commenti di markdown
Sfortunatamente, Markdown non fornisce supporto nativo per i commenti. Tuttavia, è possibile utilizzare soluzioni importate per aggiungere commenti al tuo documento Markdown.
Metodo 1
La prima sintassi per l'aggiunta di un commento in Markdown è posizionare il testo del commento all'interno di una coppia di parentesi quadrate, seguite da un colon, uno spazio e un segno di sterlina.
La sintassi è come mostrata:
[Commenta_text]: #
Il testo all'interno delle staffe quadrate è trattato come un commento e ignorato dal markdown rendering.
Un esempio è come mostrato:
## Markdown Commenti illustrazioni
Questo è un paragrafo
[Questo è un commento]: #
Il commento sopra non è visibile.
Nell'esempio sopra, abbiamo una semplice sintassi di markdown con un'intestazione, un paragrafo, un commento e un altro paragrafo.
Metodo 2
La sintassi seguente può anche inserire commenti in un documento di markdown.
[//]: # (il testo del commento va qui)
Questo è considerato il formato più compatibile con la piattaforma per l'aggiunta di commenti.
Un'altra variazione di questa sintassi è:
[//]: # "Il testo del commento va qui"
Metodo 3
In alcuni motori di markdown, è possibile saltare le due barre in avanti e utilizzare la sintassi di seguito:
[]: # (Testo dei commenti)
O
[]: # "Testo di commento"
O
[]: # 'Testo di commento'
Metodo 4
Puoi anche includere i commenti HTML in Markdown come illustrato nella sintassi seguente:
Le app di markdown popolari supportano il metodo sopra.
Metodo 5
GitHub consente anche di utilizzare la sintassi di seguito per indicare i commenti:
:: comment
Testo di commento
:/commento
Sebbene, la sintassi di cui sopra è che non è convenzionalmente adottata e utilizzata.
Chiusura
In questo tutorial, hai scoperto cinque metodi efficaci per aggiungere commenti al tuo commento di markdown.