build-process - 在自动构建中生成文档

Question

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

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

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

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

score 7 · Accepted Answer

是的！

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

score 6 · Accepted Answer

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

score 2 · Accepted Answer

Apache Forrest 项目可能会以某种方式为您提供您想要的东西。

通常最好用 XML 编写文档。从那里你应该能够生成你需要的任何东西。

score 1 · Accepted Answer

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

score 1 · Accepted Answer

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

score 0 · Accepted Answer

我有使用 Doxygen 的经验。它既好又简单，但它让您想要过度注释代码以简化以后的文档工作。

6 回答 6