编写帮助文档图文教程

Manual and Help使用指南

EC Software 公司的 Help & Manual 作为一个出色的帮助文件制作软件，它有着很多强大而实用的功能。首先，Help & Manual 能够生成五种不同格式的通用帮助文件：从Windows 3.X到Windows XP都能识别的经典HLP格式帮助文件、电子手册（RTF）、HTML格式文件、可执行文件EXE格式文件，Adobe 公司的PDF文件格式(如图1)，

以及代表着未来帮助文件发展趋势的CHM格式文件(需要Microsoft Html Help WorkShop支持)。其次，Help & Manual 具有图片插入、AVI等多媒体插入、OLE 超链接、书签设置以及插入宏等强大的链接扩展功能，可以让你制作出更为漂亮活泼、跳转灵活的帮助文件。在完成一个帮助文件后，你还可以利用Help & Manual十分方便地进行文件预览、对多个帮助文件进行合并集成、文件打印等操作，另外，Help & Manual还提供了屏幕截图和拼写检查功能。

在最新的3.0版中，操作比2.0版方便多了。单击“File | New”进入后有一个对话框(如图2)，

在这里可以选择是新建一工程，还是从众多的支持格式中导入(有HLP格式文件和HLP源文件、CHM格式和RTF格式)，单击“Next”，我们以“创建一个新工程”为例明说一下它的用法。设置好工程保存的位置和名称，选择好模板后，单击“Next”，在此处直接粘贴已编写好的目录文字（图3）。

单击“Finish”后，即可看到在目录树（Table of Contents）显示框内已经按照你所输入的文本建立好了目录结构。先在Topic Options 框内填入相应内容，然后在Help Text 框输入(粘贴)需要写入的文档，并对每一项帮助进行说明。如果你还需要加入宏、图片、多媒体等链接，可以直接在Insert菜单下选择相应的操作。值得一提的是，Help & Manual的OLE链接功能十分强大，支持PowerPoint、Excel、Adobe Acrobat、QuickTime Move等多达26种之多的文件格式，而且它还能支持未加定义的某些文件格式的文本、图形、声音、动画的链接，真可谓无所不能（图4）。

在建立好所有这些文档链接之后，你就可以利用File 菜单下的预览（Preview）功能对你做好的Help文件进行预览和检查，看看是不是让你满意。不过通过预览看到的文件（图5），

显示效果只是等同于RTF格式的电子手册，你无法通过预览功能来察看HLP格式和HTML格式等文件的真实效果。然后可以进行文件保存。注意，利用Help & Manual的保存功能只能将所有内容保存为Help & Manual 的*.hm3格式工程文件，而不能直接生成Windows的HLP格式帮助文件、电子手册（RTF）或HTML

格式文件等你需要的东西。要得到你需要的帮助文件，还必须进行“生成Help 文件”（Make help file）的操作。在工具栏中，击点（图6）小漏斗状的按钮，

就进入“生成Help文件”操作，最新的3.0版在这里变化较大，不过操作比2.0版方便多了。如图6-1，选择好输出格式后，直接点“OK”按钮，即可完成所有工作。经过编译连接后，你就可以到指定的文件夹（即保存文件的位置）找到新生成的帮助文件。打开看一看，是不是像一个很专业的帮助文件呀—目录、索引、书签一应俱全，编辑、打印、选项等项功能完整，开心吧？！使用Help & Manual 制作帮助文件的整个流程就是这样，你学会了吗？

Javadoc自动生成帮助文档

JAVADOC：自动生成你的程序开发文档 当初学习编程序的时候，就从来没有想过要给自己写的那几个程序编写一份完整的文档，所有的注释都仅仅是为了自己当时能够想起这段代码到底是干什么的，没有人想过这些代码的升级、共享问题。但是，开始做商业软件之后，一切都变了，尤其是大型的团队开发项目中。 大家也许注意到了，java的API文档总是紧紧跟随着JSDK的版本的提高而保持着最新的状态。试想一下，手工维护这么复杂的文档可能吗？当然不可能，这一切都是javadoc这个小程序的功劳（当然也有java类库作者们做程序注释的一份功劳）。API文档就是用它根据最新的源代码自动生成的，一切都是这么容易——只需要你把本来就要写的注释写得更规范一些，再稍微详细一些。然而，大家似乎好像根本就没有意识到它的存在，很少有人会用它来为自己的程序生成文档。不知道，你现在是否对它有了兴趣？好吧，下面我们就开始这个令人轻松的自动文档生成之旅。 【如何插入注释】 javadoc为你生成代码不是凭空来的，也不是它会自动分析你的代码——每个人都有自己的代码风格，如果要进行分析翻译恐怕还是机器码更容易生成百倍。它的分析机制依赖于你按照规范为你的代码添加应有而足够的注释。只有你老老实实写注释，才有可能把以前需要做双份的工作一次做了。 Javadoc工具可以从下列对象中提取出信息： · 包。 · 公共类。 · 公共接口。 · 公共或者受保护的方法。 · 公共或者受保护的变量/常数。 针对每一种特性，你都应该提供一条注释。每一条注释都要以/**打头，以*/结尾。在每条/** …… */文档注释可包括任意格式的文字。它的第一个句子应该是一个总结性的语句，javadoc会自动把它提出来制作总结页。当然，这里你完全可以使用一些HTML的记号，例如表示斜体；...表示等宽的“打印机”字体；表示粗体；甚至用包括一副图象等等。（但是不要使用类似于