在自动构建中生成文档

时间:2008-09-22 10:06:45

标签: build-process build-automation documentation

有没有办法在自动构建期间生成项目文档?

我想要一套带有用户手册的源文件(HTML?),并从中生成:

  • PDF文件
  • CHM帮助
  • 帮助的HTML版本

所有三种格式的内容基本相同。

目前我正在使用msbuild和CCNET,但如果需要,我可以改变它。

6 个答案:

答案 0 :(得分:7)

是!

  • 使用SandCastle构建API的CHM / HTM文档。
  • 使用DocBook + FOP和其他工具制作PDF,RTF,HTML等其他类型的文档......

可以通过NAnt轻松地将它们与CruiseControl.NET集成。

答案 1 :(得分:6)

你试过doxygen吗?它也适用于Windows,并且很容易将它集成到任何构建脚本/进程中。

答案 2 :(得分:2)

Apache Forrest项目可能会在某种程度上为您提供所需的内容。

通常情况下,用XML编写文档会更好。从那以后你应该能够生成你需要的任何东西。

答案 3 :(得分:1)

帮助和手册可以从单一来源生成高质量的PDF,HTML和CHM(以及其他格式)。它还有一个命令行界面。我有版本4,我很喜欢它。我使用条件(如#ifdefs)以各种格式生成我的文档的Windows和Mac版本,作为构建.bat / .csh文件的一部分。第5版现已推出。

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

答案 4 :(得分:1)

如果您也希望记录您的api,并且您正在使用msbuild,那么请考虑使用DocProject来控制SandCastle版本。 (这些工具不适用于最终用户文档......)

答案 5 :(得分:0)

我有过Doxygen的经历。它既简单又容易,但它会让您想要过度注释代码以方便以后的文档工作。