Eclipse自动生成文件注释以及使用javadoc命令自动生成API文档

本文介绍如何在Eclipse中设置自定义注释,并通过javadoc命令为项目生成API文档的具体步骤。

首先打开Eclipse编辑器,然后找到Window下的Preferences选项,点击打开它。然后按照图示操作。




打开到这个界面的时候,先选中New Java files,然后点击右边的Edit。将你想要自定义注释的内容填入Pattern中,下面注释为本人个人电脑使用注释。

${filecomment}
${package_declaration}
/**
* 这是文档注释
* @author 作者
* @version 创建时间:${date} ${time}
*/
${typecomment}
${type_declaration}


最后选中AutoMatically add comments for new methods and types,不过我没有选中该项,但是依然可以正常使用。

然后点击Apply最后点击OK。


自定义注释使用完了之后,我们可以使用javadoc命令自动生成API文档。

首先找到你创建的java项目,鼠标右击该项目,弹出该窗口,依次选中Show In,然后左击System Exploer这一项。


然后找到对应硬盘上的java文件Test.java


之后在该目录下空白处,按住键盘shift键不放右击空白处弹出该窗口,点击在此处打开命令窗口。


打开之后输入javac "自己项目里的java文件名",此处使用Test.java,编译过该文件之后。


输入命令javadoc "自己项目里的java文件名"。运行之后


找到目录下的index.html,打开它,文档就已经生成好了。


评论
成就一亿技术人!
拼手气红包6.0元
还能输入1000个字符
 
红包 添加红包
表情包 插入表情
 条评论被折叠 查看
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值