论坛首页> 三共建设

iEco集成开发环境的学习-帮助-10

 QtCreator具有非常完善的帮助手册系统,从如何编写帮助注释 -> 生成帮助文档 -> 生成帮助手册 -> Assistant查看和索引手册。这里仅介绍如何快速的上手Assistant

Assistant帮助和前面界面的项目管理的窗口风格是类似的,支持多窗口查看,每个窗口可以是不同的视图。这里对窗口的管理不再赘述,重点介绍帮助手册的几项功能。

索引视图:如图所示,输入要索引的内容,会根据已建立的索引表快速定位需要查找的内容,这种方式是开发者使用最频繁、最简单、最快速的一种查找方式。索引通常是以命名空间、Qt模块名称、类名称、函数名称、枚举类型、枚举值名称、章节名称组成。开发者需要对要搜索的内容有一个大概的了解才能实现快速索引。



索引视图




内容视图:如图所示,将所有的帮助手册根据内容的章节组织成树型结构,可以清晰明了的看到帮助手册中具体有哪些内容。这个视图主要是面向对出入门的开发者使用,因为初学者还并不清楚帮助手册提供了哪些模块、类、函数等,通过内容视图能以全局的方式来概览整个手册。


内容视图




搜索视图:如图所示,可以根据搜索关键字来搜索整个帮助手册,这种模式通常是最慢的,因为要全文搜索,所以时间会比较长。对于开发者而言,如果能通过索引查到结果,尽量不要使用搜索方式。

全文检索



书签视图:如图所示,可以将开发人员认为重要的、需要记录下来的帮助页以书签的形式存储到书签视图中。在帮助页面的功能栏,如图XX所示,有一个书签形状的按钮

用来将当前页面保存到书签视图。


书签视图


标记书签


打开文档视图:如图所示,在使用帮助手册的过程中打开的页面,会自动记录到打开文档视图中。开发者可以随时查看以往打开的帮助页,点击打开视图上的列表项,可以快速在页面之间进行切换,避免了重复查找和打开的操作。



打开文档视图


全部回复

暂无更多回复内容