关于利用Qt编写应用程序的帮助文档

转载请注明出处！

关于利用Qt编写应用程序的帮助文档

首先推荐Qt官网的example 官网的例子讲的很细致很全面，不过官网的例子全是英文的。百度文库里有对这个例子的翻译，我也看了一下，感觉还不如去看英文的。好的言归正传。

讲一下大概的步骤

1、准备.html文件（里面就是我们大家经常看到的关于应用程序的文字说明）

2、编写.qhp文件（来管理你的html文件）

3、调用qhelpgenerator 将.qhp文件编译成.qch文件

（如果你只希望自己编写的帮助文档在Qt Assistant里查看的话，到这就可以了）

4、编写.qhcp文件（来管理你的.qch文件，其实在这就可以制作自己的assistant了）

5、调用qcollectiongenerator 将.qhcp文件编译成.qhc文件

6、调用assistant 运行你自己制作的assistant

 

<1>准备.html文件

对于这个步骤，对于有些孩子没难度，不过还是要说一下。因为我一开始就不懂怎么弄。制作html文件有很多方法，我只说我是怎么弄的，别的方法我没试过哦，用wps新建一个文字文档，在里面书写你想对应用的说明（可以设置超链接）。然后在编写好说明文档之后，点击文件另存为.html文件就可以了。是不是很简单啊！

2、编写.qhp文件

讲一下这个文件的作用吧。这个文件干嘛的呢？最简洁个回答就是管理。Html文件，其实在叫我解释我不知道怎么解释了。我们可以通过Qt Assistant来直观的接触一下吧，打开Qt Assistant （位置一般在Qt安装目录的bin下面），点击菜单栏上的Edit 选择看到最后一行Preferences 弹出如图的对话框

 

你可以看到Doucumentation,选择他，点击Add弹出让你选择文件，你可能我是说可能啊！不知道要选择什么文件，我是在ubuntu系统下弄的，所以window不知道，没有试过，

/usr/share/qt4/doc/qch/  点到这看到了吧东西了吧对的就是.qch文件。你可以选择qt.qch看看，看看点击ok 你可以发现在Qt Assistant Qt的帮助手册！对的，这一步你编写的文件就是这个。有点太罗嗦了。

新建.qhp文件在linux是直接vim 来新建的后缀 **.qhp就可以了。

好吧我直接把我自己写的.qhp文件贴出来吧！本人语言有点错乱，注射讲的不好，多多包含。

 

 

 

到这，你就就可以在命令行输入：qhelpgenerator ** .qhp -o **.qch

这样就可以生产.qch文件了，按上面个步骤可以将你自己制作的.qch文件添加到Qt Assistant

里面。

3、编写qhcp文件

这个文件主要是对.qch文件进行管理，其实就相当于一个Assistant，直接上代码吧，多的我也讲的不专业。文章最先面有相关文章的连接，里面对每个文档都有比较详细的讲解！我也是查看他们的文章做的，不过激励推荐官网的例子！

 

编写好qhcp文件就可以生成qhc文件了在命令行输入：qcollectiongenerator **.qhcp-o qhc

这样就生成qhc文件了。

最后运行QtAssistant 命令：assistant-collectionFile **.qhc 这样就可以打开你自己编写的帮助文档了！是不是感觉很好玩啊！

最后还有一步其实，那家是将这个帮助文档可以在我们自己编的应用程序的help查看，还是贴个代码吧

 

特别注意在调用.qhc文件的路径问题！