加在类上面就是类的注释，加在方法上就是方法的注释
新建一个class，然后在package下面写如下代码
@author代表作者名
@version代表版本名
@since代表需要最早使用的jdk版本
public class Doc {
String name;//属性
public String test(String name) throws Exception{
return name;
}//方法
@param代表参数名
@return 代表返回值情况
@throws代表异常抛出情况
二. 查找JavaDoc文件
JavaDoc是一种将注释生成HTML文档的技术，生成的HTML文档类似于Java的API，易读且清晰明了。
1）通过命令行查找JavaDoc文件
右击Doc文件，进行以下操作
点开Explorer，再在文件夹索引框最前面加上cmd+空格
打开命令框之后输入javadoc -encoding UTF-8 -charset UTF-8 Doc.java
可以发现生成了htlm文件
然后再返回我们刚刚打开的文件
然后打开index.html文件（index是首页的意思）
然后就可以找到JavaDoc文件了
2）使用IDEA生成JavaDoc文档
点开Tool
-
第一步：选择局部还是整体，选择生成JavaDoc文档的范围，我只对一个源文件生成Doc，所以选择文件
-
第二步：选择文件生成的位置
-
第三步：区域设置，决定文档的语言，简体中文就是zh_CN、繁体(台湾)zh_tw、繁体(香港)zh-hk、英语(香港)en-hk、英语(美国)en-us、英语(英国)en-gb、英语(全球)en-ww。我们一般会使用zh_CN。
-
第四步：其他命令行参数：如果区域设置为中国，参数一般为 -encoding UTF-8 -charset UTF-8 主要意义是为了显示中文不出现乱码。
-
第五步：点击确定就可以了
然后就会出现以下界面
这样就得到了我们生成的生成的文档了（index.html ）
