自动生成文档

时间:2020-03-06 14:31:57  来源:igfitidea点击:

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

我想在用户手册中使用一组源文件(HTML?),并从中生成:

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

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

目前,我正在使用msbuild和CCNET,但可以根据需要更改它。

解决方案

是的!

  • 使用SandCastle来构建API的CHM / HTM文档。
  • 使用DocBook + FOP和其他工具以PDF,RTF,HTML等格式生成其他类型的文档...

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

Apache Forrest项目可能会以某种方式为我们提供所需的内容。

通常最好用XML编写文档。由此,我们应该能够生成几乎任何我们需要的东西。

我们尝试过Doxygen吗?它也可用于Windows,应该很容易将其集成到任何构建脚本/进程中。

帮助和手册可以从单一来源生成高质量的PDF,HTML和CHM(以及其他格式)。它还具有命令行界面。我有版本4,我非常喜欢。我使用条件语句(如#ifdefs)来生成Windows和Mac版本的文档,这些文档以各种格式生成.bat / .csh文件。版本5现在可用。

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

如果我们也要记录api的信息,并且正在使用msbuild,请考虑使用DocProject来控制SandCastle构建。 (这些工具不适用于最终用户文档...)

我有过Doxygen的经验。它很不错而且很容易,但是它使我们想对代码进行注释,以简化以后的文档编制工作。