首页 > 技术文章 > 在MyEclipse中使用javadoc导出API文档详解

tengqiuyu 2017-03-31 15:18 原文

本篇文档介绍如何在MyEclipse中导出javadoc(API)帮助文档,并且使用htmlhelp.exe和jd2chm.exe生成chm文档。

具体步骤如下:

 

  1. 打开MyEclipse,选中想要制作API文档的Java项目,右击选择Export弹出窗口,选择Java下面的Javadoc点击Next进入下一个界面。(Export——Java——Javadoc——Next)

 

 

  2.选择想要导出API文档的项目(默认已选)和目标文件夹(默认在项目目录下,可修改),点击Next进入下一步。

(Javadoc comand选择JDK的bin目录下的javadoc.exe。选择要生成的源代码和javadoc保存的目的路径,下一步)

 

 

 

  3.填写文档标题,点击Next进入下一步。

 

 

 

  4.图中红色框中是设置编码格式的,如导出的文件出现乱码的话,这里可以这样设置: -encoding UTF-8 -charset UTF-8 。

然后点击Finish。

 

 

  5.点击“Yes To ALL”继续。

 

 

  6.控制台会打印一系列生成文档的信息。

 

 

  7.打开目标文件夹,找到index.html打开即可查看API文档信息。

 

 

  8.下载htmlhelp.exe和jd2chm.exe放到API文档目录下,安装htmlhelp.exe,并打开jd2chm.exe。

 

 

 

 

  9.在jd2chm.exe窗口中输入两遍文档名称,程序运行并自动关闭。在文档目录中即可看到已经生成的chm格式API文档。

 

推荐阅读