使用 Eclipse 帮助系统为项目编制文档

核心提示： 查看文档测试您的插件的最简单方法就是，将整个目录（像上面的一样）拖入到已经安装 Eclipse 平台的插件目录下，使用 Eclipse 帮助系统为项目编制文档(3)，然后启动 Eclipse 并选择 Help > Help Contents，您将得到一个添加了您的插件的帮助窗口（类似于 图

查看文档

测试您的插件的最简单方法就是，将整个目录（像上面的一样）拖入到已经安装 Eclipse 平台的插件目录下，然后启动 Eclipse 并选择 Help > Help Contents。您将得到一个添加了您的插件的帮助窗口（类似于 图 1中那个）。

使用 IDE 来进行测试当然是好的，但是为了在没有 IDE 时也可以使用，文档需要更加易用，所以我们真正希望的是要后台运行一个进程，让我们可以在浏览器中连接它。这种方式的操作被称为 InfoCenter（见图 4）。启动 InfoCenter 进程（基本上是 Apache Tomcat）的指令包含在 Eclipse 帮助系统文档中。注意，还有一些指令用来简化 Eclipse 系统，以便刚好满足您的需要。

图 4. 运行的 InfoCenter

查看原图（大图）

处理庞大的目录

如果您的项目有多人参与工作，或者有大量的文档，那么更新单个目录文件 (toc.xml) 会变得不切实际。为改变这一状况您可以向主 toc.xml 文件中的主题添加一个 link 元素（见清单 3 的示例）。

清单 3. 目录定义

<toc　label="Sample　Documentation">　
　　<topic　label="My　Section"　href="mySection.html">　
　　　　<topic　label="Foo"　href="foo.html"/>　
　　　　<topic　label="Bar"　href="bar.html">　
　　　　　　<link　toc="bar-toc.xml"　/>　
　　　　</topic>　
　　</topic>　
</toc>