3.9 JavaDoc生成文档
javadoc命令是用来生成自己API文档的
javadoc是一种技术，他可以将我们的注释信息生成一个帮助文档
参数信息
@author 作者名
@version 版本号
@since 指明需要最早使用的JDK版本
@param 参数名
@return 返回值情况
@throws 异常抛出情况
文档注释
/**回车，加在类的上方就是类的注释，加在方法的上方就是方法的注释
package com.baidu.www;
/**
* @author 肆悟先生
* @version 1.0
* @since 1.8
* 这个注释是加在类上面的，除此之外还可以加在方法中
*/
public class Doc {
String name;//这是一个属性
/**
*
* @param name
* @return
* @throws Exception
* 给方法加的文档注释，自动生成以上参数
*/
public String test(String name) throws Exception{
return name;
}
}
使用Javadoc命令可以生成javadoc文档
javadoc -encoding UTF-8 -charset UTF-8 Doc.java
# -encoding UTF-8设置编码为UTF-8这样可以正常显示中文
# -charset UTF-8 设置字符集编码为UTF-8也是为了正常显示中文
如图
生成文档如图
