Documentação fora do código [RESOLVIDO]

1. Documentação fora do código [RESOLVIDO]

Samuel Leonardo
SamL

(usa XUbuntu)

Enviado em 23/07/2016 - 15:57h

Existe algum meio automatizado, como o Doxygen, de gerar uma documentação de programa toda "bonitinha" e formatada com diagrama de classes e tudo mais?
Eu não quero usar o doxygen porque acho que deixa muito poluído os headers, acho melhor usar algo que deixe o código de lado e que possa ter a mesma funcionalidade do Doxygen mas que não precise escrever nos headers do source.




  


2. MELHOR RESPOSTA

Uilian Ries
uilianries

(usa Linux Mint)

Enviado em 23/07/2016 - 16:19h

O próprio Doxygen permite escrever a documentação separada do header/source.


/*! \fn int open(const char *arquivo,int modo)
\brief Abre um arquivo
\param arquivo O nome do arquivo
\param modo "r" para leitura, ou "w" para escrita.
\return Identificador para o arquivo aberto, ou -1 em caso de erro.
*/


Veja em http://www.stack.nl/~dimitri/doxygen/manual/docblocks.html#structuralcommands

Sinceramente, incluir o Doxygen no header não é poluído e essa é a forma adotada em grandes projetos Open Source.

Pense quando for utilizar um biblioteca em C ou C++. Vai precisar do header para poder utilizar junto ao seu código. A documentação presente no header irá permitir:
- Agilidade na busca por informação;
- Garantia de versão compatível entre documentação e código fonte;
- Facilidade em distribuição da documentação junto ao código.

O que geralmente está separado do código, são documentos para diagramas UML mais elaborados, que são gerados por outros softwares, como PlantUML, Astah, Dia, etc.
--
Uilian Ries





Patrocínio

Site hospedado pelo provedor RedeHost.
Linux banner
Linux banner
Linux banner

Destaques

Artigos

Dicas

Tópicos

Top 10 do mês

Scripts