为内置帮助系统(QtHelp)生成 HTML 帮助的工具和方法?

发布于 2024-08-22 00:29:46 字数 1539 浏览 0 评论 0原文

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

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

发布评论

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

评论(2

七色彩虹 2024-08-29 00:29:46

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

过去,我们使用 Wiki(MediaWiki 和 DokuWiki)来记录文档,但一旦您想要以格式正确的形式打印或发送文档(例如 PDF 指南),这就会被证明是有问题的。

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

I hate to answer my own questions, but we eventually decided to settle for LaTeX.

In the past we used a Wiki (MediaWiki and DokuWiki) for documentation, but that proved to be problematic as soon as you wanted to print or ship the documentation in a decently formatted form (PDF guide for instance).

LaTeX is not much more complex compared to a Wiki markup language, but produces beautiful PDF files, and there are also a series of LaTeX-to-HTML compilers, which produce decent HTML documentation with graphics, Tables Of Contents and clickable links and sections.

忆离笙 2024-08-29 00:29:46

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

要获得更全面的文档生成器列表,维基百科和 Google 是您的朋友。 http://en.wikipedia.org/wiki/Comparison_of_documentation_generators

祝你好运

编辑< /strong>
好的,Thread 发布者宣布他已经使用了 Doxygen。然而,维基百科页面仍然存在,我想

我可以问一下你正在使用什么语言吗?

If you're writing your application in JavaScript, you might wish to look at JSDoc.
For other languages, Doxygen is a good choice, too. http://www.doxygen.nl/
Doxygen can output HTML and PDF formats =)

For a more comprehensive list of documentation generators, Wikipedia and Google are your friends. http://en.wikipedia.org/wiki/Comparison_of_documentation_generators

Good luck

Edit
Ok, Thread poster has announced he used Doxygen already. However, the wikipedia page still stands, I guess

Might I ask what language you're working with?

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