eclipse关联和生成javadoc文档

时间:2021-02-10 09:34:41

一、eclipse关联添加javadoc

javadoc是从程序源代码中抽取类、方法、成员等注释形成一个和源代码配套的API帮助文档。Eclipse有直接查看java文档和类库源码的功能,不过得手工添加才行,下面对如何在Eclipse中添加javadoc文档和类库源码进行总结。
(1)Window->Pereferences...打开参数选择对话框,展开Java节点,单击"Installed JREs",此时右边窗口会显示已经加载的jre。
(2)选中要设置的jre版本,单击"Edit",弹出JRE编辑窗口。
(3)添加javadoc:将JRE system libraries下的所有包选中,单击右边的"Javadoc Location"按钮,弹出javadoc设置窗口。选择"Javadoc URL"单选框,单击"Browse"按钮,选中docs/api目录,然后点击"OK"。
(4)添加source:将JRE system libraries下的所有包选中,单击右边的"Source Attachment"按钮,弹出source attachment configuration窗口。单击"External File"按钮,选中java安装目录中的src.zip文件,然后点击"OK"。
(5)后面就一路OK,确定就行了。
最后,在添加好了javadoc后,在eclipse中,使用快捷键"Shift+F2",可快速调出选中类的api文档。

二、eclipse生成javadoc

javadoc.exe是自动生成java文档的小工具。在eclipse里面可以很方便的使用这个小工具,主要有三个常见的入口

(1)File —> Export —> java —> javadoc
(2)Project —> Generate Javadoc
(3)在工程上右键 —> Export —> java —> javadoc
上面三个入口殊途同归,都是进入Generate Javadoc界面。如下图所示:
eclipse关联和生成javadoc文档
接下来你必须要做的事情有:
第一步:Configure(配置),即找到javadoc.exe的路径,默认情况下在Java安装路径下。
第二步:选择要生成 javadoc的工程。
第三步:选择要生成javadoc的成员,选private就是所有成员都会生成。
第四步:选择你要输出的位置,默认输出到工程下的doc文件夹下面。
点击Finish然后就可以看到生成的文档了,很高效的工具。

当然,利用next的配置,我们可以设置字符集。如下图所示:
  eclipse关联和生成javadoc文档
在Extra Javadoc options中可以设置:
-encoding UTF-8     //-encoding charsetName 是指源文件编码
-charset UTF-8      //-charset charsetName 用于跨平台查看文档的字符集,它对应着你生成的html文件中的头部的charset