Comentário de Marydown

Markdown é um dos idiomas de marcação mais populares do mundo. Criado por John Gruber em 2004, o Markdown é uma linguagem de marcação simplista e leve que permite adicionar elementos de formatação ao texto sem formatação.

O Markdown é independente da plataforma e pode ser transportado em praticamente qualquer aplicativo. Como resultado, ele ganhou amplo uso em desenvolvimento da web, como blogs, documentos, notebooks, e -mails e etc.

Como funciona o Markdown?

Como mencionado, o Markdown é uma linguagem de marcação. Portanto, você trabalha em um arquivo que termina em .md ou .Extensão de Marydown. Este arquivo contém elementos de formatação, como títulos, blocos de código, recortes, alinhamentos e etc.

O documento de marcação é processado por um aplicativo conhecido como processador ou analisador de marcação. O analisador pega o texto formatado e produz o documento HTML. Você pode visualizar o documento HTML em um navegador ou qualquer aplicativo que o suporta.

A imagem abaixo ilustra como esse processo funciona.

(Esta imagem é um guia de marcação de formulário.)

Você pode aprender mais sobre como o Markdown funciona no recurso abaixo:

https: // www.MarkdownGuide.org/

O que é um comentário de rekrown?

Um comentário de remarcação refere -se a um texto adicionado a um arquivo de remarkdown, mas ignorado pelo aplicativo renderizador. Assim, um comentário de remarcação não é exibido na saída gerada.

Os comentários são úteis quando você precisa incluir texto oculto no seu documento que é visível apenas para o autor do documento, mas não exposto no documento resultante.

Como inserir comentários de remarca

Infelizmente, o Markdown não fornece suporte nativo para comentários. No entanto, você pode usar soluções importadas para adicionar comentários ao seu documento de marcação.

Método 1

A primeira sintaxe para adicionar um comentário em Markdown é colocar o texto do seu comentário dentro de um par de suportes quadrados, seguido por um cólon, um espaço e um sinal de libra.

A sintaxe é como mostrado:

[comentário_text]: #

O texto dentro dos colchetes é tratado como um comentário e ignorado pelo renderizador de remarcar.

Um exemplo é como mostrado:

Ilustração de comentários de marcação
Este é um parágrafo
[Este é um comentário]: #
O comentário acima não é visível.

No exemplo acima, temos uma sintaxe simples de marcação com um título, um parágrafo, um comentário e outro parágrafo.

Método 2

A sintaxe abaixo também pode inserir comentários em um documento de marcação.

[//]: # (o texto do comentário vai aqui)

Isso é considerado o formato mais compatível com a plataforma para adicionar comentários.

Outra variação desta sintaxe é:

[//]: # "O texto do comentário vai aqui"

Método 3

Em alguns mecanismos de marcação, você pode pular as duas barras para a frente e usar a sintaxe abaixo:

[]: # (texto de comentário)
ou
[]: # "Comentário Texto"
ou
[]: # 'Comentário Texto'

Método 4

Você também pode incluir comentários HTML em Markdown, conforme ilustrado na sintaxe abaixo:

Os aplicativos de remardo populares suportam o método acima.

Método 5

O Github também permite que você use a sintaxe abaixo para denotar comentários:

:: Comente
texto de comentário
:/Comente

Embora a sintaxe acima seja que ela não seja adotada e usada convencionalmente.

Fechamento

Neste tutorial, você descobriu cinco métodos eficazes para adicionar comentários ao seu comentário de remarca.