A forma mais comum é o comentário HTML
Coloque a observação entre `<!--` e `-->`. Renderizadores que aceitam comentários HTML não exibem esse trecho como conteúdo da página.
A sintaxe vem do HTML incorporado ao Markdown. Uma plataforma que bloqueia HTML bruto pode mostrar os sinais, escapar o texto ou remover o comentário durante a publicação.
# Notas da versão
<!-- Conferir a data antes de publicar. -->
A versão 2.4 está disponível.Notas da versão
A versão 2.4 está disponível.| Objetivo | Use | Limite |
|---|---|---|
| Lembrete editorial portátil | <!-- observação --> | O destino precisa aceitar comentário HTML |
| Nota exclusiva do Obsidian | %% observação %% | Outros programas podem mostrar o texto |
| Guardar segredo | Não colocar no arquivo | Ocultar não protege |
| Ensinar a sintaxe | Bloco de código | Os marcadores ficam visíveis |
O conteúdo continua no arquivo
Mesmo invisível na leitura, o comentário permanece no `.md`. Quem abrir o texto puro, consultar o histórico do repositório ou baixar o arquivo consegue ler a observação.
Anote tarefas como revisar uma fonte, trocar uma imagem provisória ou conferir uma tabela. Não coloque tokens, senhas, documentos pessoais, dados de clientes ou resultados ainda sigilosos.
- Comentário não substitui permissão de acesso.
- Em repositório público, considere a observação pública.
- Apague lembretes resolvidos que não ajudam a próxima revisão.
- Se um segredo foi versionado, retirar apenas da versão atual não basta.
Como escrever comentários curtos e longos
Uma frase cabe entre os marcadores na mesma linha. Para uma lista de revisão, abra o comentário, escreva as linhas e feche com `-->`.
Revise o fechamento sempre que editar um bloco maior. Sem ele, o restante do documento pode ser interpretado como parte do HTML e desaparecer da saída.
<!--
Antes da publicação:
- testar os links
- conferir os totais
- revisar os textos alternativos
-->A lista não aparece como conteúdo, mas continua na fonte.No GitHub, a visualização esconde e o código revela
A documentação do GitHub ensina comentários HTML para ocultar conteúdo do Markdown renderizado. A mesma nota continua acessível quando alguém abre o código do README.
Isso é útil para orientar contribuidores, desde que a mensagem possa ser lida por qualquer visitante do repositório.
## Instalação
<!-- Atualizar este comando quando o pacote mudar. -->
```sh
npm install
```A observação não aparece na página renderizada e permanece na aba de código.`%%` funciona no Obsidian, não no Markdown inteiro
O Obsidian aceita comentários inline e em bloco entre `%%`. Eles ficam disponíveis durante a edição e são omitidos no modo de leitura.
Essa escrita é uma extensão do Obsidian. Ao levar a nota para GitHub, outro editor ou um CMS, os sinais e o comentário podem aparecer normalmente. Para arquivos que circulam entre ferramentas, o comentário HTML tende a ser mais portátil.
O rascunho está pronto. %%Pedir a revisão do orçamento.%%Outro renderizador pode exibir a frase inteira.Dentro de um bloco de código, os sinais são literais
O conteúdo de uma cerca de código deve ser mostrado exatamente como foi escrito. Por isso `<!-- -->` dentro dela vira parte do exemplo e não uma nota escondida.
Informar `html` depois das crases muda o realce de sintaxe, não as regras de processamento do bloco.
```html
<!-- Esta linha aparece como código. -->
<p>Exemplo</p>
```Um bloco de código HTML visível com o comentário.Por que o resultado varia entre renderizadores
O CommonMark reconhece comentários como HTML bruto, mas cada produto pode desativar ou higienizar esse HTML. Uma conversão para HTML, DOCX ou PDF também pode descartar a observação.
A prévia local confirma somente aquele renderizador. Teste também a plataforma de publicação e o arquivo final que será entregue.
| O que aconteceu | Causa provável | O que conferir |
|---|---|---|
| A nota sumiu da prévia | Comentário HTML aceito | Abrir o Markdown original |
| Os sinais apareceram | HTML bruto bloqueado | Configuração do destino |
| O texto seguinte desapareceu | Faltou `-->` | Pares de abertura e fechamento |
| O exportado não contém a nota | Higienizador removeu | Comparar fonte e artefato |
Um checklist simples antes de publicar
Comentários devem facilitar a revisão e sair do caminho quando deixam de ser úteis. Evite acumular instruções antigas no documento.
- Defina o destinoSaiba se o arquivo vai para GitHub, Obsidian, um CMS ou outro renderizador.
- Escreva apenas o que pode ser lidoConsidere que qualquer pessoa com acesso ao arquivo verá a nota.
- Abra fonte, prévia e downloadCada etapa pode tratar o comentário de maneira diferente.
- Remova o que já foi resolvidoMantenha apenas contexto útil para futuras edições.
Ferramentas relacionadas
Perguntas frequentes
Qual é a sintaxe de comentário em Markdown?
Markdown não tem um marcador próprio universal. Se o destino aceitar HTML bruto, use `<!-- comentário -->`.
Comentários Markdown são privados?
Não. Eles podem sumir da página renderizada e continuar legíveis no arquivo, no histórico ou em um download.
Comentários HTML funcionam no README do GitHub?
Sim. O GitHub os oculta na renderização, mas mantém o texto visível no código do README.
O que significa `%% comentário %%`?
É uma extensão do Obsidian, não uma sintaxe portátil. Outros programas podem mostrar a observação.
Posso fazer um comentário com várias linhas?
Sim. Coloque as linhas entre `<!--` e `-->` e verifique se o fechamento está correto.
Por que meu comentário aparece na página?
O destino pode bloquear HTML bruto ou a sintaxe pode estar dentro de um bloco de código. Teste no renderizador final.
Posso colocar uma senha em um comentário?
Não. Ocultar da renderização não protege o conteúdo do arquivo.