0

我正在将基于 QtHelp 的内置帮助系统实施到我的应用程序中。由于 QtHelp 是基于 Qt 的帮助集合文件,所以我需要生成一组 HTML 页面。

由于我不会单独编写文档(我的一些同事也会编写),因此我正在寻找生成这些文件的最佳方法。

我们在内部使用 Wiki,我知道文档应该用某种标记语言编写,而不是给所有作者一个所见即所得的 HTML 编辑器。

所以我的问题是,是否有工具可以帮助生成文档,这些文档可以导出为一组 HTML 文件,也可能导出为 PDF?

提前致谢!

更新:

我已经在使用 Doxygen 来生成 C++ 文档。但我并不完全在寻找 API 文档生成器,而是像 LaTeX 这样的东西,它允许您像标记文档一样格式化文档内容(很像 Wiki)。

4

2 回答 2

0

如果您使用 JavaScript 编写应用程序,您可能希望查看 JSDoc。
对于其他语言,Doxygen 也是一个不错的选择。 http://www.doxygen.nl/
Doxygen 可以输出 HTML 和 PDF 格式 =)

对于更全面的文档生成器列表,维基百科和谷歌是你的朋友。 http://en.wikipedia.org/wiki/Comparison_of_documentation_generators

祝你好运

编辑
好的,线程海报宣布他已经使用了 Doxygen。但是,我猜维基百科页面仍然存在

我可以问一下您使用的是什么语言吗?

于 2010-02-21T21:23:25.807 回答
0

我讨厌回答我自己的问题,但我们最终决定接受 LaTeX。

过去,我们使用 Wiki(MediaWiki 和 DokuWiki)作为文档,但一旦您想以格式正确的形式打印或发送文档(例如 PDF 指南),这就会出现问题。

与 Wiki 标记语言相比,LaTeX 并不复杂,但可以生成漂亮的 PDF 文件,还有一系列 LaTeX-to-HTML 编译器,它们可以生成带有图形、目录和可点击链接和部分的不错的 HTML 文档。

于 2010-03-09T11:02:06.293 回答