javaDoc文档的生成
Doc注释的主要参数信息
/**
*@author 作者名
*@version 版本号
*@since 指明需要最早使用的jdk
*@param 参数名
*@return 返回值情况
*@throws 异常抛出情况
*/
Doc注释的区分
package java学习;
/**
* @author nothing
* @version 1.0
* @since 1.8
* 加在类上面就是类注释
*/
public class Demo01 {
/**
* 既不在类上面也不在方法上面
*/
String name;
/**
*
* @param name
* @return
* @throws Exception
* 加在方法上面就是方法注释
*/
public String test(String name) throws Exception{
return name;
}
}
Doc文档的生成
- 以所要生成的文档路径进入命令控制台
- javadoc -encoding UTF-8 -charset UTF-8 Demo01.java
javadoc 为命令
-encoding为编码
UTF-8为编码格式
Demo01.java为所要生成的Doc文件