在自动构建中生成文档

发布于 2024-07-05 00:14:42 字数 202 浏览 6 评论 0 原文

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

我想要一组包含用户手册的源文件(HTML?),并从中生成:

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

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

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

Is there any way to generate project docs during automated builds?

I'd like to have a single set of source files (HTML?) with the user manual, and from them generate:

  • PDF document
  • CHM help
  • HTML version of the help

The content would be basically the same in all three formats.

Currently I'm using msbuild and CCNET, but I could change that if needed.

如果你对这篇内容有疑问,欢迎到本站社区发帖提问 参与讨论,获取更多帮助,或者扫码二维码加入 Web 技术交流群。

扫码二维码加入Web技术交流群

发布评论

需要 登录 才能够评论, 你可以免费 注册 一个本站的账号。

评论(6

最佳男配角 2024-07-12 00:14:43

是的!

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

它们可以通过 NAnt

Yes!

  • Use SandCastle to build CHM/HTM documentation of the APIs.
  • Use DocBook + FOP and other tools to produce other kinds of documentation in PDF, RTF, HTML etc...

They can be easily integrated with CruiseControl.NET through NAnt.

会发光的星星闪亮亮i 2024-07-12 00:14:43

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

Did you try doxygen? It's available for Windows too and it should be easy to integrate it in any build script/process.

策马西风 2024-07-12 00:14:43

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

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

The Apache Forrest project might go some way to giving you what you want.

You'll be generally better off writing your documentation in XML. From that you ought to be able to generate just about anything you need.

合久必婚 2024-07-12 00:14:43

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

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

Help and Manual can generate good quality PDF, HTML and CHM (and other formats) from a single source. It also has a command line interface. I have version 4 and I like it a lot. I use conditionals (like #ifdefs) to to generate Windows and Mac versions of my documentation in various formats as part of a build .bat/.csh file. Version 5 is now available.

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

幼儿园老大 2024-07-12 00:14:43

如果您也希望您的 api 被记录下来,并且您正在使用 msbuild,那么请考虑使用 DocProject 来控制 < a href="http://www.codeplex.com/SHFB" rel="nofollow noreferrer">SandCastle 构建。 (这些工具不适用于最终用户文档......)

If you want your api's documented too, and you are using msbuild, then consider using DocProject to control the SandCastle build. (These tools are not for end-user documentation...)

妳是的陽光 2024-07-12 00:14:43

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

I've had an experience with Doxygen. It is nice and easy, but it makes you want overcommenting the code to ease later documetation work.

~没有更多了~
我们使用 Cookies 和其他技术来定制您的体验包括您的登录状态等。通过阅读我们的 隐私政策 了解更多相关信息。 单击 接受 或继续使用网站,即表示您同意使用 Cookies 和您的相关数据。
原文