Como faço para adicionar comentários em markdown?

2024-09-02

Versão curta

Markdown não suporta comentários nativamente. Use comentários HTML em vez disso.

<!-- Este é um comentário -->

Versão longa

Introdução

Embora o Markdown seja perfeito para criar texto formatado, ele não possui um recurso de comentário embutido. No entanto, você ainda pode adicionar comentários utilizando elementos de comentário HTML.

Adicionando Comentários em Markdown

Para adicionar comentários no seu arquivo Markdown, basta usar a sintaxe do comentário HTML. Qualquer coisa escrita dentro de  será ignorada durante a renderização:

<!-- Este comentário não aparecerá na saída -->

Você pode adicionar comentários em qualquer lugar do seu documento sem afetar o conteúdo da saída.

Conclusão

Para adicionar comentários em Markdown, usar comentários HTML continua sendo a melhor abordagem. Dessa forma, você pode incluir notas e explicações no seu Markdown bruto que não aparecerão no documento final.