java生成JavaDoc文档(MyEslipse和dos命令生成)

MyEslipse生成:

1、点击eclipse的【Project】菜单,选择【Generate JavaDoc】选项。
或者打开Eclipse,在需要生成Javadoc的项目上右击鼠标,在弹出来的列表中点击”Export“选项。
在这里插入图片描述
或者
在这里插入图片描述
2、Next

(1)选择您要生成JavaDoc的工程,在弹出来的”Export“窗口中,选择导出的目标,这里选择Java文件夹下的Javadoc,然后点击”Next“按钮。

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

(3)选择doc的生成位置,默认为工程目录下,建议不要修改。
在这里插入图片描述
3、继续下一步
进入到”配置Use standard doclet的Javadoc变量“界面,可以根据需要配置Javadoc的变量,可以通过”基本选项“下的复选框来选择Javadoc选项。如果想引用一个库中的类,并且将该库链接到它的javadoc,可以在“Select referenced…”列表中选择,然后点击“Next”按钮。
在这里插入图片描述
4. 继续下一步
进入到“配置Javadoc变量”界面,这里注意:如果项目采用的是UTF-8编码,Extra Javadoc options(额外的Javadoc选项)下需要输入设定参数:-encoding utf-8 -charset utf-8否则生成的网页中文注释都是乱码,点击“Finish”按钮。
在这里插入图片描述
5. 可以看到控制台输出生成javadoc的信息。

在这里插入图片描述
4、打开doc目录,用浏览器打开index.html
在这里插入图片描述
5、最终可以看到一个完整的API文档、javadoc就生成了
在这里插入图片描述

dos生成doc文件:

在doc命令提示符下生成java特有的文档,方便别人阅读你的注释,和理解你的程序
方法/步骤1:
在dos命令提示符中进入到Register.java所在的位置编译你要生成文档的类。如以下是编译Register.java
在这里插入图片描述
方法/步骤2:
会看到有一个Register.class文档在你的Register.java目录中
在这里插入图片描述
方法/步骤3:
然后在dos命令提示符中输入:javadoc -d myhelp -author -version Register.java
-d 表示生成的目录位置,myhelp表示生成文档所在当前目录下的文件夹名
-author是作者的名字
需要注意的是:
要想将某类文档化,该类必须是公共类
//私有的类则不会在文档中显示
//公有的和受保护的则能显示
不然会出现下面这情况:
在这里插入图片描述
方法/步骤4:
改成public类之后,再次输入:javadoc -d myhelp -author -version Register.java
则会在目录中看到以下这个文件夹
在这里插入图片描述
方法/步骤5:
打开这个文件夹。会看到如下文件。
在这里插入图片描述
方法/步骤6:
单击index.html后则可以打开你生成的文档了。你可以添加多个,如:javadoc -d myhelp -author -version Register.java AAA.Jjava 。。。。。这里只有Register.java这一个
在这里插入图片描述

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值