Kdevelop使用手册: kdevelop集成开发环境之参考指南,unix系统,1.2版
后退 | 章 6. 帮助系统 | 前进

# 6.4. 使用文件浏览器

文件浏览器documentation browser 允许快捷的访问随Kdevelop提供的或自动生成 的所有的手册及文件, 包括KDE 库KDE-libraries 及你的项目文件的在线文档。另 外, 树视图中的文件树允许你设置一个额外的包含了所有个人加入文件的"其他" 文件夹。

## 6.4.1. 要求

要使用帮助浏览器Helpbrowser 的所有特色, 你应该线安装KDoc 及 glimpse 。KDoc 将在setup 过程中为KDE 库KDE-libraries 生成 各种各样的在线类--文件, 但也可通过KDevelop Setup 中的选项激活。对于一个你的项目的类 classes 的API (Application Programming Interface)文件的生成, KDoc 也会被项目菜单中"生成API -Doc"使用和访问。这将处理项目所有的当前的头文件及 对Qt和KDE-libraries 前后参照，如果它们在帮助浏览器Helpbrowser 中可用。 对于项目手册的生成, 你应该至少在你的系统上安装KSgml2Html (由KDE-SDK 提供)及, SGML -tools。要扩展及更改你的项目的在线文件, 你必须通过在RFV 中选择它来为你的项目编辑文档文件。在保存了你的改动后，从项目菜单中访问"建立用户 手册" 。假如 SGML tools 检测到格式化错误errors , 错误将会显示在输出 output 窗口，允许你直接找出错误行。"glimpse "程序用于自动为你的文件创 建一个个人的搜寻索引。索引通常在安装过程中建立, 但也可利用KDevelop Setup 对话建立。要得到所提供的搜寻功能的描述，请 参见使用搜索索引。

## 6.4.2. 提供的文档

KDevelop IDE 有两套在线文档, 可以通过帮助菜单或在Kdevelop文件夹中通过树视图的文 档树来获得。所提供的第一本书就是这本包含了所有你需要的安装及设置，可用功能及应用 开发介绍信息的在线手册。第二本书的首版是KDevelop编程手册。编程手册包括与创建及扩展由KDevelop生 成的项目相关的大多数问题。通过此教程，用户得到关于由Qt- 和/或 KDE-libraries 创建的应用所提供的丰富功能的介绍，还为保证KDE -compliance 提供了指导,在位于 \|\|的Internet 网站上提供相同介绍。然而, 编程手 册不能代替任何其他可用的关于C++编程语言打印出的或是电子形式的文件，及关于Qt-库 的使用的文件。

KDevelop 使用的C/C++-参考Reference 当前只有在位于\|\|的Kdevelop主页上可用。在发布时该参考可能会包括进 去, 可参见所发布的安装程序索引以获得更多信息。它可通过下载和拷贝源文件到主要的 KDE-目录($KDEDIR)来轻易安装。然后，你必须使用`tar zxvf c&_;c++&_;reference.tar.gz` 将它作为根部, 然后参考将被拷贝KDevelop的文件目录。要卸载参考文件，你只需在 ($KDEDIR)/share/doc/HTML/default/kdevelop/reference下删除"参考"文件夹。

Qt/KDE-libraries 文件夹允许直接访问你的Qt-库拷贝的HTML -在线文件。库 文件的路径通常使由Kdevelop安装程序自动检测, 但也可在KDevelop Setup 对话中手动设置。而且，所有KDE库KDE- libraries 的可用文件都以库名顺序列出, 因此如果你要使用某个库的类classes ， 你可以很容易的决定要加入项目中连接器Linker 设置的库的类型。注意，整个KDE- 库文件只有当由KDoc 生成时才可进入---因此包含于KDE-SDK 中的这个程序, 必 须文件生成以前安装。由于Kdevelop的安装程序自动完成次步骤, 它应当在运行KDevelop 安 装程序前安装。如果不是这样且文件不能建立, 你可以利用KDevelop Setup 对话在其后任何时间创建它。 文件树还包含"其他" 文件夹，这些文件夹旨在包含所有个人设置的文档，如下。最后, 文 档树允许访问API 及你当前项目的手册。

## 6.4.3. 将文件加入帮助浏览器Helpbrowser

要设置你的帮助浏览器Helpbrowser , 先打开树视图并选择"DOC "定位装置。 你 会看见一个打开包含四哥文件夹的树。"其他" 文件夹缺省为空。用鼠标在这个文件夹上右 击, 一个上下文菜单会打开，它包含了一个"增加入口"项。选择它会打开增加入口对话，你 必须在此输入两个值: 上面一个是文档在文档树中显示的文件名，下面一个是文件入口行, 你必须在此输入其后通过选择该入口将被打开的起始页的路径和文件名。你可以直接输入路 径及文件名或通过选择右边的按钮来打开一个文件选择对话。这允许对你的系统进行快速浏 览以查找你的起始页的路径。注意，只有HTML -文件可以选择, 所以只允许选择 HTML 文件。选择OK 会将入口加入文档树并可直接使用。

## 6.4.4. 使用搜寻索引

KDevelop 包含了一套功能，帮助你利用HTML 文件查找信息。要使用这些特色, 你的 系统需要安装"glimpse "程序, 一个免费的数据库生成器-它会生成搜寻索引 search index 并在文件内执行搜寻操作。要建立索引, 请参见KDevelop Setup 。索引也可在安装程序中自动生成。

如下，有几种方式可以进入查寻功能，你可以选择:

1. 在编辑器editor 中, 选择你想要获得帮助的文本活将光标置于你要查寻的单词 中。然后右击鼠标选择设置: "语句"。这也可通过从帮助菜单中选择"搜寻标注文本"、按下 快捷键F2 或通过从工具条选择搜寻按钮来完成。

2. 在文件浏览器中选择你要找寻的文本并按下鼠标右键, 选择找寻:"语句" 或选择 "找 寻标注文本" 或如上使用找寻按钮。

3. 如果你想要查找一个特定的关键字, 在帮助菜单中选择"查找对...的帮助" 或从工具 条中选择"查找对...的帮助" 按钮, 然后会打开一个查找对话，你可以在此输入你想要得到 信息的词句。

可通过在"DOC " -树-浏览中选择相关按钮或通过帮助菜单的条目直接进入特定文件。

帮助浏览器Helpbrowser 还提供对文本查找工具grep 在你当前的文档中查找 所选文本的支持, 例如，你已经为`KTMainWindow` class (KDEUI library)打开文档页 并希望知道`KTMainWindow`出现在你代码中的哪个位置。标注`KTMainWindow`并选择 "文本查找工具: KT主视窗"或按下Shift+F2。"在文件中查找"对话会打开并直接显示你的 文本查找工具grep 的搜寻结果。然后你可以选择一个结果行并跳至相关资源代码。

后退 | 起点 | 前进
配置HTML 浏览器 | 上一级 | 使用编辑器