制作帮助文件步骤

用HTML help Workshop软件制作chm文件很方便，也很简单。

主要分成如下几步：1、为每个主题编辑一个HTML文件，并用Internet E xplorer检查确认无误。

HTML文件可以用任何一个HTML编辑器编辑，也可用Htmlhelp Workshop编辑。

2、创建项目文件（会生成一个.hhp后缀的文件）3、创建目录文件（会生成一个.hhc后缀的文件），可选4、创建索引文件（会生成一个.hhk后缀的文件），可选完成以上步骤后，进行编译即可生成相应的chm文件。

项目相关文件介绍1、 .hhp文件，这是最常用的一类文件，它实际上是“HTML Help project”的缩写，表示HTML帮助文件项目，它是生成CHM文件最直接用到的一类文件，只需要有一个hhp文件就可以根据它来编译相应的CHM文件。

2、.hhc文件，它是“HTML Help table of contents”的缩写，表示的是HTML帮助文件的目录，通常我们在CHM文件浏览器的左边窗口中看到的目录内容就由它来提供，当然，它并不能直接被编译成CHM文件，而先要集成到某一hhp文件中才能发挥作用。

3、 .hhk文件，它是“HTML Help Index Keyword”的缩写，为我们提供了CHM文件的关键字索引查询功能，也是一个易于查看的帮助文件不可缺少的一部分，同hhc文件一样，它也不能直接编译生成相应的CHM文件。

使用说明运行Htmlhelp Wo rkshop时，它的工作窗口很简单，菜单栏上有五个命令，分别是1、“File（文件）”2、“View（校验）”3、“Test（测试）”4、“Tools（工具）”5、“Help（帮助）”下面的工具栏有五个按钮，分别是1、“New（新建）”2、“Open（打开）”3、“Compiled HTML file（编译HTML文件）”4、“View Compiled file（校验编译文件）”5、“Display online information（联机帮助）”下面介绍具体步骤一、创建项目文件1、单击HTML help Workshop菜单或工具栏中的“New（新建）”命令，这时出现“选择新建内容”的对话框。

用微软help workshop制作帮助文件提交日期：2003-12-23 浏览: 258用微软help workshop制作帮助文件制作帮助文件主要有以下几个步骤完成：＊利用Word软件制作帮助文件的原始说明文件（.rtf）。

＊利用Hcw软件制作帮助文件的书签索引文件（.cnt）。

＊利用Hcw软件建立工程文件（.hpj）。

＊在工程文件中将说明文件和索引文件编译成帮助文件（.hlp）。

一、制作帮助文件的原始说明文件说明文件的书写要遵循一定的格式，说明文件一般由标题区、脚注区和正文区组成。

1) 标题区：标题区是书写帮助文件每一章节的提头说明，它在阅读时不放在滚动条内。

2) 脚注区：在帮助文件每一个标题的开始加上脚注，常用的有以下几种符号：＄帮助文件浏览时记录的标题信息，放在书签菜单中，并可通过“《、》”按钮循环观看，一般用每一章的标题记录。

＃帮助文件每个标题的ID值，通过它可以标识每个说明标题，通过它来和其他的跳转以及书签索引文件取得联系。

K 与每个标题相关的关键字，以后显示在进入帮助文件的树状图中，通过它可快速找到所要查询主题。

＋浏览帮助文件时每页的顺序。

3) 正文区：正文区用来编写帮助文件的主要部分，每个标题的内容写完以后，都要插入一个分页符，以便和下一个标题内容分开。

其特殊格式如下：跳转：跳转用双下划线字体表示，后跟要跳转到某个标题的ID值，要用隐藏字体。

旁注：旁注指用鼠标单击后弹出的一小段注释，用单下划线字体表示，后跟要跳转到某个标题的ID值，要用隐藏字体。

位图：位图指在帮助文件中插入bmp格式的图片，可以直接在WORD文档中插入，也可用下列命令表示：{bmc filename.bmp}热点：热点指用鼠标单击后跳转去执行一个宏命令,可以在跳转后跟叹号和宏命令，要用隐藏字体，如果是位图热点，也可在Hotspot软件中去制作，如下所示：画笔!Exec(paint.exe) 插入一个文字热点{bmc paint.bmp}!Exec(paint.exe) 插入一个位图热点。

制作帮助文件速成帮助文件速成(上)----带有帮助文件的应用程序无论对程序员还是用户都是不同凡响的，它能节省印刷大量用户手册的开支，对程序员编辑修改和用户手册的复制保存都极为方便。

帮助文件的另一个很有前景的应用是单独作为带有图文信息的电子图书发布。

----在此对帮助文件的编制及如何在程序中编程调用作一详尽介绍。

首先介绍第一部分，帮助文件的编写。

----帮助文件的编写步骤：先编写存有所有帮助信息的帮助源文件RTF文件。

编写帮助项目文件HPJ文件。

对HPJ文件编译，最后生成HLP文件。

帮助源文件RTF文件的编写----帮助源文件是存有所有帮助信息的，这是一种RTF（RichTextFormat)文件,帮助文件象一本书，由目录及一个个章节组成，各章节之间的跳转是由定义的热点来完成。

现在举一具体例子（由目录等五条信息组成）详细说明。

----原始信息由五个章节组成：目录、概述、说明、程序、安装。

象前面每一节的标题（“目录”，“概述”，“说明”，“程序”，“安装”）在RTF文件中必须以特有的脚注（即$)明确指定。

对每一节还须指定其跳转名(脚注是#，跳转名不能是汉字），以便标识，在这我们给每一节分别取名为：contents,description,explanation,programming,setup,对每一节还可指定其搜索关键字（脚注是K），关键字可以是一个或多个，汉字和英文均可。

----具体操作如下：进入MicrosoftWord中文版,选择：文件/新建，先输入第一节的内容：输入第一节的标题：“目录”，将光标移到“目录”的前面，选择系统菜单的“插入”，选“脚注和尾注”，选“脚注”和“自定义标记”，输入：$符号，这时文档下方出现脚注编辑窗口，光标也自动落在文档下方的脚注编辑窗口中，在光标处接着输入这一节的标题：“目录”，有时看不到文档下方的脚注窗口，这只要将系统菜单中“视图”的“脚注”选上。

----下面定义这一节的跳转名,将光标移到“目录”的前面，选择系统菜单的“插入”，选“脚注和尾注”，选“脚注”和“自定义标记”，输入：#符号，这时文档下方出现脚注编辑窗口，光标也自动落在文档下方的脚注编辑窗口中，在光标处接着输入这一节的跳转名：“contents”(有时看不到文档下方的脚注窗口，这只要将系统菜单中“视图”的“脚注”选上)定义这一节的搜索关健字。

.如何制作1.在word里写好帮助内容后，保存为rtf格式，记住必须是rtf2.HelpWorkshop新建一个hlp文件。

要完成一个可以使用的hlp帮助文件，内容挺多的。

例如在word中要加入不同的标记这些标记在HelpWorkshop将被识别并赋以不同的作用。

制作帮助文件主要有以下几个步骤完成：＊利用Word软件制作帮助文件的原始说明文件（.rtf）。

＊利用Hcw软件制作帮助文件的书签索引文件（.cnt）。

＊利用Hcw软件建立工程文件（.hpj）。

＊在工程文件中将说明文件和索引文件编译成帮助文件（.hlp）。

一、制作帮助文件的原始说明文件说明文件的书写要遵循一定的格式，说明文件一般由标题区、脚注区和正文区组成。

1)标题区：标题区是书写帮助文件每一章节的提头说明，它在阅读时不放在滚动条内。

2)脚注区：在帮助文件每一个标题的开始加上脚注，常用的有以下几种符号：1. 在每页首插入脚注，脚注编号方式选“自定义方式”，自定义标记为“#”、“$”或“K”，各自含义如下：“#”用于定义该页标识名，页面跳转就是跳到具有指定标识名的页面。

“$”用于定义该页的标题，这个标题会显示在Help的历史窗口中。

“K”用于定义该页的索引词，各索引词用“;”隔开，用于Help的检索。

浏览帮助文件时每页的顺序。

2. 设置跳转文字的字体为双下划线，紧跟跳转文字后面写下要跳转到的页面的标识名，并将该标识名的字体设为单下划线的隐藏文字. 这样在生成的Help文件中可以看到跳转文字为带有下划线的绿色文字，鼠标一点就跳到指定页面了。

3)正文区：正文区用来编写帮助文件的主要部分，每个标题的内容写完以后，都要插入一个分页符，以便和下一个标题内容分开。

其特殊格式如下：跳转：跳转用双下划线字体表示，后跟要跳转到某个标题的ID值，要用隐藏字体（选中需要隐藏的字体点“格式-字体的效果里有隐藏字体选项”，当需要去掉时，选中所有文字同样点击格式-字体里的隐藏字体，把那个勾去掉）。

Java帮助⽂档的制作和使⽤⼀般我们写⼀些⼤型项⽬时，会有多⼈分⼯合作负责写不同的类。

1.其中包含main⽅法的类叫做测试类 测试类的作⽤：创建其他类的对象，并调⽤其他类的功能。

2.包含了详细步骤的⽅法都放在⼀个类中，这个类叫做功能类 功能类的作⽤：⽤来存放相关功能的操作。

⼤家分⼯合作的时候，别⼈给我们的⽂件⼀般都会是class⽂件，⽽不是java⽂件。

因为class⽂件是看不到源代码的，这样⼀来，你根本不知道别⼈的功能类⾥的源代码是怎么写的。

为了更好的使⽤别⼈的class⽂件，⼀般会制作⼀个说明书，⽤于讲解功能类中各个⽅法的使⽤步骤。

如何制作⼀个说明书？1.写⼀个功能类2.对这个类中的⽅法加⼊⽂档注释3.⽤⼯具解析⽂档注释(javadoc⼯具) ⼯具使⽤格式：javadoc -d ⽬录 -auther -version 功能类名.java 注释⽂档的书写格式：第⼀⾏开头使⽤/**，最后⼀⾏使⽤*/，中间每⼀⾏开头使⽤* /** * * */ 注意事项：1.功能类需要⽤public修饰，否则没有权限访问； 2.有参数的⽅法必须使⽤"@param ⽅法名"来注释； 3.有返回值的⽅法必须使⽤"@return"来注释。

使⽤说明书：找到上⾯⽬录所在位置，使⽤浏览器打开index.html⽂件。

使⽤帮助⽂档： 标准的帮助⽂档⼀般都是chm格式，具体使⽤步骤如下： 1.直接打开chm格式的帮助⽂档。

2.点击“显⽰”，打到“索引”，看到输⼊框。

3.输⼊要查找的名字，⽐如Scanner。

4.看包的名称：如果是ng包下的类就不需要导⼊，其他的包均需要导⼊。

Scanner类是java.util包下的类，需要导⼊：java.util.Scanner。

5.看类的解释和说明，还有类的使⽤版本，不同的jdk版本能使⽤的类不同。

6.看类的结构： 成员变量 字段摘要 构造⽅法 构造⽅法摘要 成员⽅法 ⽅法摘要 7.学习构造⽅法 A.有构造⽅法，就创建对象 B.没有构造⽅法，成员可能都是静态的 8.看成员⽅法 A.左边 是否静态：如果静态，可以通过类名调⽤ 返回值类型：返回什么，就⽤什么接收 B.右边 看⽅法名：⽅法名称不要写错 参数列表：⼈家要什么参数，就给什么；⼈家要⼏个参数，你就给⼏个。