自定义软件帮助文档（qt assistant实现）

我是标同学

已于 2023-02-11 19:52:58 修改

阅读量1.3k

点赞数 1

分类专栏： qt 文章标签： qt文档浏览软件 qt帮助文档 Powered by 金山文档

于 2023-02-11 16:42:21 首次发布

本文链接：https://blog.csdn.net/kangkanglhb88008/article/details/128985076

版权

qt 专栏收录该内容

90 篇文章 48 订阅

订阅专栏

网上搜了一下，软件的帮助文档，三个都可以：

https://github.com/zealdocs/zeal，https://zealdocs.org/，看看这个博客说的 https://blog.csdn.net/libaineu2004/article/details/125028913，这个也是开源的，源代码可能也不算复杂吧，反正就是自己看看吧，但是用法也可以通过外部进程进行调用实现文档浏览。

qt assistant，https://www.bbsmax.com/A/MyJxLV8eJn/，https://blog.csdn.net/weixin_35911805/article/details/116703602，https://www.cnblogs.com/ncepubye/p/17012751.html，https://blog.csdn.net/a15005784320/article/details/98843436。

chm格式帮助文档，这个和qt assistant是类似的，都是从html文件生成的，现在用的人好像不多了，https://zhuanlan.zhihu.com/p/510925324。

这里主要了解了一下qt assistant（也是网上很多人推荐的），这个是通过当作后台外部进程的方式来使用的，如果我们想要看它的源码，也是可以的，https://code.qt.io/cgit/qt/qttools.git/tree/src/assistant/assistant，我看代码不少。

qt creator本身也是通过后台外部进程来调用qt assistant实现的技术文档浏览功能（可以指定一些配置参数，从而实现控制这个文档浏览软件的图标，菜单栏等，从而匹配自己的软件风格是一体的官方介绍：https://doc.qt.io/qt-6/assistant-custom-help-viewer.html#creating-a-custom-help-collection-file，此外设置这个进程的的父窗口为我们的软件窗口，就能实现融合一体https://blog.csdn.net/tusong86/article/details/105866808），但是可能改动了其源码，使得界面控件显示都不一样了的，当然我们也可以按照上面说的源码进行改动来实现我们自己的文件浏览器。

反正，学习如何使用，就看qt creator自带的例程 Simple Text Viewer Example，https://www.cnblogs.com/taqikema/p/7517278.html，https://blog.csdn.net/yanjiang2008666/article/details/8646104

注意，这个例程，可能提示xx.pch文件路径不对，那么我们就把对应文件夹拷到这个地址文件路径即可。

从源代码生成帮助文档，直接只用qt的qdoc即可（如果是chm文档，那么用doxygen软件https://zhuanlan.zhihu.com/p/510925324），https://blog.csdn.net/weixin_30256505/article/details/99766699。因为是从源代码生成的帮助文档，所以里面的类型定义等关系是可以直接跳转的，因为这些软件原理其实是做了语法分析了。