Dokumente im automatisierten Build generieren

8

Gibt es eine Möglichkeit, Projektdokumente während automatisierter Builds zu generieren?

Ich hätte gerne ein einziges Set von Quelldateien (HTML?) mit dem Benutzerhandbuch und von ihnen generieren:

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

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

Momentan verwende ich msbuild und CCNET, aber ich könnte das bei Bedarf ändern.

    
Juanma 22.09.2008, 10:06
quelle

6 Antworten

7

Ja!

  • Verwenden Sie SandCastle , um eine CHM / HTM-Dokumentation der APIs zu erstellen.
  • Verwenden Sie DocBook + FOP und andere Werkzeuge, um andere Dokumentationen in PDF, RTF, HTML usw. zu erstellen.

Sie können leicht mit CruiseControl.NET über NAnt integriert werden.

    
Sklivvz 22.09.2008, 10:11
quelle
6

Hast du Doxygen versucht? Es ist auch für Windows verfügbar und es sollte einfach sein, es in jedes Build-Skript / jeden Build zu integrieren.

    
unexist 22.09.2008 10:16
quelle
2

Das Apache Forrest-Projekt könnte Ihnen etwas geben, was Sie wollen.

Im Allgemeinen ist es besser, wenn Sie Ihre Dokumentation in XML schreiben. Daraus sollten Sie in der Lage sein, alles zu generieren, was Sie brauchen.

    
paul 22.09.2008 10:12
quelle
1

Hilfe und Handbuch können gute PDF, HTML und CHM (und andere Formate) aus einer einzigen Quelle erzeugen. Es hat auch eine Befehlszeilenschnittstelle. Ich habe Version 4 und ich mag es sehr. Ich benutze Bedingungen (wie #ifdefs), um Windows- und Mac-Versionen meiner Dokumentation in verschiedenen Formaten als Teil einer Build-.bat / .csh-Datei zu generieren. Version 5 ist jetzt verfügbar.

Ссылка

    
Andy Brice 22.09.2008 10:49
quelle
1

Wenn Sie möchten, dass Ihre APIs auch dokumentiert sind und Sie msbuild verwenden, dann sollten Sie DocProject verwenden, um SandCastle Build. (Diese Tools sind nicht für die Endbenutzerdokumentation gedacht ...)

    
thijs 10.10.2008 14:44
quelle
0

Ich habe eine Erfahrung mit Doxygen gemacht. Es ist nett und einfach, aber es lässt Sie den Code überbewerten, um spätere Dokumentationsarbeiten zu erleichtern.

    
akalenuk 10.10.2008 14:47
quelle

Tags und Links

Django: Verwenden von Annotate, Count und Distinct in einem Queryset Wie gehst du mit verschiedenen Java IDEs und svn um?