HyperFluxCMS

Fast. Flexible. Free.

HyperFluxCMS

Documentando código em HyperCode

Como inserir documentários nos códigos das suas postagens

publicado 01/01/2025 15:17, atualizado 14/04/2026 23:17

O HyperCode permite que você documente seu código com comentários ocultos para o leitor que visita seu site. Veja como.

No sentido computacional, "Documentar" um arquivo tem um significado diferente do usado no cotidiano. Significa inserir, em algum código, anotações legíveis ao usuário que facilitem a compreensão e que não alterem o comportamento do código.

O HyperCode permite que se documente o código, ou seja, insira comentários, que ajudem a orientar quem o está escrevendo ou editando, mas que não aparecem para o visitante. Você pode, por exemplo, colocar o comentário "Atualizar a imagem quando o fotógrafo enviar a nova foto" em uma postagem, para lembrá-lo disso, sem que isso apareça ao visitante.

Um comentário também pode ser usado para neutralizar uma parte do texto que se deseja esconder temporariamente, mas não exclui-lo em definitivo, por estar, por exemplo, aguardando uma revisão.

Para inserir um comentário no código no HyperFluxCMS, deve-se marcar o início do bloco comentado com [! e terminar com !]. Tudo o que estiver entre a marcação de início e de final seá ignorado. Não aparecerá ao visitante do site, nem será indexado, nem aparecerá no código HTML.

Exemplo:

E assim encerramos com sucesso mais uma confraternização de fim de ano entre os amigos e colaboradores do projeto.
[! lembrete: inserir mais fotos do evento !]