Gibt es eine Möglichkeit, Projektdokumente während automatisierter Builds zu generieren?Dokumente im automatisierten Build generieren
Ich möchte einen einzigen Satz von Quelldateien haben (HTML?) Mit der Bedienungsanleitung, und von ihnen generieren:
Der Inhalt wäre im Grunde in allen drei Formaten identisch.
Derzeit verwende ich Msbuild und CCNET, aber ich könnte das ändern, wenn nötig.
Ja!
Sie lassen sich leicht mit CruiseControl.NET durch NAnt integriert werden.
Das Apache Forrest-Projekt könnte einen Weg zu Ihnen geben, was Sie wollen.
Sie werden Ihre Dokumentation in der Regel besser in XML schreiben können. Daraus sollten Sie in der Lage sein, alles zu generieren, was Sie brauchen.
Haben Sie versucht Doxygen? Es ist auch für Windows verfügbar und es sollte einfach sein, es in jedes Build-Skript/jeden Build zu integrieren.
Hilfe und Handbuch können gute Qualität PDF, HTML und CHM (und andere Formate) aus einer Hand generieren. 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.
Wenn Sie Ihre api dokumentiert zu wollen, und Sie verwenden msbuild, betrachten dann DocProject mit dem SandCastle Build zu steuern. (Diese Werkzeuge sind nicht für Endbenutzer-Dokumentation ...)
Ich habe eine Erfahrung mit Doxygen gehabt. Es ist nett und einfach, aber es lässt Sie den Code überbewerten, um spätere Dokumentationsarbeiten zu erleichtern.