Générer des documents en version automatisée
https://stackoverflow.com/questions/114095
-
02-07-2019 - |
italiano
english
français
española
中国
日本の
العربية
Deutsch
한국어
Português
RussianQuestion
Existe-t-il un moyen de générer des documents de projet lors de la génération automatisée?
J'aimerais avoir un seul ensemble de fichiers source (HTML?) avec le manuel d'utilisation, et générer à partir d'eux:
- document PDF
- Aide du CHM
- Version HTML de l'aide
Le contenu serait fondamentalement identique dans les trois formats.
Actuellement, j'utilise msbuild et CCNET, mais je pourrais le changer si nécessaire.
La solution
Oui!
- Utilisez SandCastle pour créer la documentation CHM / HTM des API.
- Utilisez DocBook + FOP et d’autres outils permettant de produire d’autres types de documentation au format PDF, RTF, HTML, etc.
Ils peuvent être facilement intégrés à CruiseControl.NET via NAnt .
Autres conseils
Avez-vous essayé doxygen ? Il est également disponible pour Windows et il devrait être facile de l’intégrer dans n’importe quel script / processus de construction.
Le projet Apache Forrest pourrait vous donner ce que vous voulez.
Il sera généralement préférable d'écrire votre documentation en XML. À partir de là, vous devriez pouvoir générer à peu près tout ce dont vous avez besoin.
Help and Manual peut générer des fichiers PDF, HTML et CHM (et d'autres formats) de bonne qualité à partir d'une source unique. Il a également une interface de ligne de commande. J'ai la version 4 et je l'aime beaucoup. J'utilise des conditions (comme #ifdefs) pour générer les versions Windows et Mac de ma documentation dans divers formats dans le cadre d'un fichier .bat / .csh de construction. La version 5 est maintenant disponible.
Si vous souhaitez également documenter votre api et que vous utilisez msbuild, envisagez d'utiliser DocProject pour contrôler la SandCastle . (Ces outils ne sont pas destinés à la documentation de l'utilisateur final ...)
J'ai eu une expérience avec Doxygen. C’est simple et agréable, mais cela vous donne envie de dépasser le code pour faciliter le travail de documentation ultérieur.
