通过Eclipse 为java 项目生成Api 文档、JavaDoc

本文详细介绍了如何使用Eclipse IDE生成Java项目的JavaDoc文档,包括选择工程、设置文档级别、指定标题、选择JDK版本及解决编码问题的步骤。

1.点击eclipse 的【Project】 菜单,选择【Generate JavaDoc】选项

1040464-20171021180842537-1054880174.png

2. Next

   (1)选择您要生成JavaDoc的工程

(2)选择哪些级别的内容生成JavaDoc,默认为public,如果选择private则会全部内容都生成。

 

1040464-20171021182751677-1246475515.png

3. 继续下一步

(1) 勾选DocumentTitle,然后填写文档标题

(2) 点击【Next】按钮

1040464-20171021182008568-1963114171.png

4.继续下一步

(1)选择使用的jdk 版本

(2)点击【Finish】按钮

注意这里加上一个:-encoding UTF-8 -charset UTF-8,可以解决  编码GBK的不可映射字符”问题

1040464-20171021182120990-356536122.png

可以看到控制台输出生成javadoc的信息

9e8d43dfcbf8f6e21ef00a67454297aafe9.jpg

6、项目下生成一个【doc】的目录,里面存放着javadoc文档

a3d98d0c4ff0baef22632c999a67fa249af.jpg

7、打开doc目录,用浏览器打开index.html

1040464-20171021182415771-1291326017.png

8、最终可以看到一个完整的API文档、javadoc就生成了。

1040464-20171021182503271-2064356471.png

转载于:https://my.oschina.net/kuchawyz/blog/2877307

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值