写一份Java文档注释

啥玩意？

 

Java文档注释以注释的形式编写，注释里可以写上这个代码起到了什么，怎么调用。与此同时， Java为大家提供了把文档注释转换为网页文档的工具，这使别人无需打开这个类文件就能从网站上看到这个类的使用说明书，帮助了软件开发人员，使用人员之间更好的交流。

 

 

使用方法

 

1.首先给你的代码写上文档注释

文档注释的格式是斜杠后面有两个*，如图

 

 

2.右击这个类所在的java项目——Export

 

 

3.打开Java文件夹下的Javadoc——Next

 

 

4.关键是红框中的Javadoc路径，这个路径其实是你的jdk文件夹下——bin文件夹下——javadoc.exe文件

 

 

5.可以看下我的，jdk虽然不同，但是都有javadoc.exe

 

 

6.点击finish。

 

 

7.请找到第四步你保存的javadoc路径，你会发现有个doc

 

 

8.进去后打开Index.html

 

 

9.恭喜，你的专业文档编写成功~