代码之家 › 专栏 › 技术社区 › BastiBen

为内置帮助系统(qthelp)生成HTML帮助的工具和方法?[关闭]

documentation-generation documentation html

0

BastiBen · 技术社区 · 16 年前

我正在将基于qthelp的内置帮助系统实现到我的应用程序中。由于qt help基于qt的帮助收集文件,所以我需要生成一组HTML页面。

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

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

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

事先谢谢!

更新:

我已经使用doxGEN用于C++文档生成。但我并不是在寻找API文档生成器,而是类似于LaTex的东西,它允许您将文档内容格式化为标记文档(很像wiki)。

2 回复 | 直到 16 年前

1

0

Warty 16 年前

如果您正在用JavaScript编写应用程序,那么您可能希望查看JSDoc。
对于其他语言,doxygen也是一个不错的选择。 http://www.stack.nl/~dimitri/doxygen/
doxygen可以输出html和pdf格式=)

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

祝你好运

编辑
好的,线程海报已经宣布他已经使用了多西根。不过,我想维基百科的页面仍然存在

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

2

0

BastiBen 16 年前

我不想回答我自己的问题,但我们最终决定用乳胶。

在过去,我们使用wiki(Mediawiki和Dokuwiki)作为文档,但一旦您希望以适当的格式打印或发送文档(例如PDF指南),这就被证明是有问题的。

与维基标记语言相比,LaTex并不复杂,但它可以生成漂亮的PDF文件,还有一系列LaTex到HTML编译器,它们可以生成带有图形、目录和可单击链接和节的体面的HTML文档。