在自动构建中生成文档

Question

有没有办法在自动构建过程中生成项目文档？

我想要一组带有用户手册的源文件（HTML？），并从中生成：

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

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

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

Answer 1

是的！

• 使用 沙堡 构建 API 的 CHM/HTM 文档。
• 使用 文档书 + FOOP 以及其他工具来生成 PDF、RTF、HTML 等其他类型的文档...

它们可以通过以下方式轻松地与 CruiseControl.NET 集成： 南安特.

Answer 2

你试过了吗 强力氧？它也适用于 Windows，并且应该很容易将其集成到任何构建脚本/进程中。

Answer 3

Apache Forrest 项目可能会在某种程度上为您提供您想要的东西。

一般来说，用 XML 编写文档会更好。由此你应该能够生成你需要的任何东西。

Answer 4

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

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

Answer 5

如果您也希望您的 api 被记录下来，并且您正在使用 msbuild，那么请考虑使用 文档项目 来控制 沙堡 建造。（这些工具不适用于最终用户文档......）

Answer 6

我有过使用 Doxygen 的经历。它很好也很简单，但它让你想要过度注释代码以简化以后的文档工作。