Gerar documentação com Natural Docs


Natural Docs é um gerador de documentação em código aberto, multi-linguagem e extensível. O código fonte é documentado numa sintaxe natural que pode ser lida como texto.
O Natural Docs varre o código fonte e cria documentação HTML de alta qualidade a partir dele.

Este gerador de documentação, produzido originalmente em Perl, foi reescrito em C# na versão 2.0, tornando-se até três vezes mais rápido. O output também foi redesenhado. Veja-se este exemplo.

O Natural Docs suporta várias linguagens de programação. E podem ser adicionadas mais por configuração.
Este gerador de código usa sintaxe markdown para criação do markup. Veja-se como documentar o código aqui.

Exemplo de especificação técnica

Markdown


Documento gerado


Referência completa do Natural Docs aqui.



Relacionado: Metodologias ágeis e documentação
Licença CC BY-SA 4.0 Silvia Pinhão Lopes, 18.8.17
Print Friendly and PDF

Sem comentários:

Com tecnologia do Blogger.