①help的api的生成
1:项目中的生成javadoc或右击项目的导出,成javadoc格式。
2:找打jdk中的Javadoc位置。如果忘记可以同cmd窗口通过指令寻找jdk位置,还可以直接再我的电脑中搜索javadoc。查找Javadoc.exe路径位置,填入javadoc命令中。
3导出就可以获得html格式的api帮助文件。
② 将帮助文件嵌入到GUI程序中。
鼠标监听事件,点击后弹出html网页文件
方法一使用的方法:使用cmd指令打开(也可用借助java.awt.desktop打开)
代码如下:

public void help()
{
File file = new File("doc/package-summary.html");
Runtime ce=Runtime.getRuntime();
try {
ce.exec("cmd /c start " file.getAbsolutePath());
} catch (IOException e) {
e.printStackTrace();
}

这里建立file文件建立相对路径,编译时相对与projiect内部文件夹,导出时相对jar程序。这个,就不用将doc文件放置再固定文件,而是相对放置就可以使用,在编译的过程中,路径名称不能包括空格,否则会识别不出,在运行jar文件时,文件夹名称也不可以改动。(很多程序的内部文件是不可以改动的。)
方法二使用的方法:也可用借助java.awt.desktop打开
代码如下:

public void help()
{File file = new File("doc/package-summary.html");
try {
Desktop.getDesktop().open(file);
} catch (IOException e) {
// TODO 自动生成的 catch 块
e.printStackTrace();
}}

这种方法可以识别父类路径中有空格的情况,符合更多需要。此程序从方案一优化到方案二。

③ 细节注意:这里面只有把注释写好,才能体现更好的帮助API文件,

使用eclipse自带制作帮助系统_help


使用eclipse自带制作帮助系统_api_02


使用eclipse自带制作帮助系统_api_03