Generieren docs in automatisierten Build

Question

Gibt es eine Möglichkeit Projekt-Dokumentation zu erzeugen, während der automatisierten baut?

Ich mag einen einzigen Satz von Quelldateien haben (HTML?) Mit der Bedienungsanleitung, und von ihnen erzeugen:

• PDF-Dokument
• CHM-Hilfe
• HTML-Version der Hilfe

Der Inhalt wäre im Grunde das gleiche in allen drei Formaten.

Ich verwende msbuild und CCNET Zeit, aber ich könnte das ändern, wenn nötig.

Answer 1

Ja!

• Verwenden Sie CHM Sandcastle / HTM Dokumentation der APIs zu bauen.
• Verwenden Sie DocBook + FOP und andere Werkzeuge, um andere Arten von Dokumentation in PDF, RTF, HTML usw. ...

Sie lassen sich leicht mit CruiseControl.NET integriert werden durch NAnt .

Answer 2

Haben Sie versucht, doxygen ? Es ist für Windows zu Verfügung und es sollte in jedem Build-Skript / Prozess einfach zu integrieren sein.

Answer 3

Das Apache Forrest Projekt könnte eine Möglichkeit Ihnen zu geben gehen, was Sie wollen.

Sie werden in der Regel in XML besser das Schreiben der Dokumentation sein. Daraus sollten Sie in der Lage sein, nur um etwas zu erzeugen, die Sie benötigen.

Answer 4

Hilfe und Handbuch kann gute Qualität PDF, HTML und CHM (und andere Formate) erzeugt aus einer Hand. Es hat auch eine Kommandozeilen-Schnittstelle. Ich habe Version 4 und Ich mag es sehr. Ich benutze conditionals (wie #ifdefs) auf Windows und Mac Versionen meiner Dokumentation in verschiedenen Formaten als Teil eines Build .bat / .csh-Datei zu erzeugen. Version 5 ist ab sofort verfügbar.

http://www.ec-software.com/

Answer 5

Wenn Sie Ihre api wollen auch dokumentiert, und Sie verwenden msbuild, dann erwägen, mit DocProject steuern die Sandcastle zu bauen. (Diese Werkzeuge sind nicht für Endbenutzer-Dokumentation ...)

Answer 6

Ich habe eine Erfahrung mit Doxygen hat. Es ist schön und einfach, aber es macht Sie den Code wollen overcommenting später-Dokumentation über Arbeit zu erleichtern.