2010-07-30 12 views
2

Je suis un programmeur à la pointe de tout-maîtresse-de-aucun et en sautant autour des langues, la qualité de la documentation cohérente est de plus en plus importante pour moi. J'ai récemment utilisé Doxygen, mais Wikipedia révèle la liste ridicule habituelle des cadres similaires.Système de générateur de documentation préféré?

Quel est votre générateur de documentation préféré et pourquoi? (Votez où vous acceptez de le garder rangé!)

Répondre

2

J'utilise différents fichiers écrits dans MediaWiki MarkUp, car c'est facile à apprendre pour tout le monde. Je convertis ceci en HTML et un fichier CHM, et en LaTeX pour la documentation PDF.

Cela a été la manière la plus simple pour moi de générer de la documentation en ligne ET de la documentation imprimable en un seul coup avec un moyen simple de saisie.

Les outils que j'utilise sont org.eclipse.mylyn.wikitext avec un DocumentBuilder personnalisé pour LaTeX, le compilateur Microsoft Help (qui fonctionne malheureusement uniquement sous Windows) et une distribution LaTeX.

EDIT: J'ai réussi à faire fonctionner le compilateur d'aide de Microsoft avec Wine, afin que mon serveur de construction Linux puisse maintenant créer toute la documentation automatiquement.