JavaDoc生成文档

javadoc命令是用来生成自己的API文档的（即帮助文档）

参数信息

        @author  作者名

        @version  版本号

        @since  指明需要最早使用的jdk版本

        @param   参数名

        @return  返回值情况

        @throws  异常抛出情况

总体效果如图

 

几点解释：

1，一般注释可以采用"/* */"如果刚开始输入"/**"再按回车就会自动在下一行开头生成"*"

2，在类的上面写的就是类的注释，在方法的上面写的就是方法的注释

在介绍效果之前插播一下打开所在文件夹的新方法

 

我们利用命令行来生成API文档

 基本格式:javadoc 参数 java文件

其中-encoding UTF-8 -charset UTF-8是为了让中文字符尽量不乱码

上图表示已生成，警告目前不用管

生成后文件夹中多出了很多项，打开框起来的那项

点开后页面如下，打开箭头所指

 发现我们刚刚定义的注释在其中呈现了，例如