Gerar docs em compilação automatizada
https://stackoverflow.com/questions/114095
-
02-07-2019 - |
italiano
english
français
española
中国
日本の
العربية
Deutsch
한국어
Português
RussianPergunta
Existe alguma maneira de gerar docs projeto durante compilações automatizadas?
Eu gostaria de ter um único conjunto de arquivos de origem com o manual do usuário, ea partir deles gerar HTML (?):
- documento PDF
- CHM ajuda
- versão HTML da ajuda
O conteúdo seria basicamente o mesmo em todos os três formatos.
Atualmente estou usando msbuild e CCNET, mas eu poderia mudar isso, se necessário.
Solução
Sim!
- SandCastle para construir CHM / documentação HTM das APIs.
- DocBook + FOP e outras ferramentas para a produção de outros tipos de documentação em PDF, RTF, HTML etc ...
Eles podem ser facilmente integrado com CruiseControl.NET através NAnt .
Outras dicas
Você tentou doxygen ? Ele está disponível para Windows e também deve ser fácil para integrá-lo em qualquer script de construção / processo.
O projeto Apache Forrest pode ir alguma maneira a dar-lhe o que quiser.
Você será geralmente melhor escrever sua documentação em XML. Do que você deve ser capaz de gerar praticamente qualquer coisa que você precisa.
Ajuda e manual pode gerar boa qualidade PDF, HTML e CHM (e outros formatos) de uma única fonte. Ele também tem uma interface de linha de comando. Eu tenho a versão 4 e eu gosto muito. Eu uso condicionais (como #ifdefs) para gerar versões Windows e Mac de minha documentação em vários formatos como parte de um arquivo de construção .bat / .csh. Versão 5 já está disponível.
Se você quiser que o seu api está documentado também, e você estiver usando msbuild, então considere o uso DocProject para controlar a SandCastle construção. (Essas ferramentas não são para documentação do usuário final ...)
Eu tive uma experiência com Doxygen. É agradável e fácil, mas isso faz você querer overcommenting o código para facilitar o trabalho documetation mais tarde.
