JavaDoc
JavaDoc命令用来生成自己API文档的- 参数信息:
@author:作者名@version:版本号@since:指明需要最早使用的JDK版本@param:参数名@return:返回值情况@throws:异常抛出情况
package demo;
/**
* @author 万恶的沫白
* @version 1.0
* @#since 1.8
*/
public class Doc {
String name;
/**
* 设置name
*
* @param name 名称
*/
public void SetName(String name) {
this.name = name;
}
/**
* 获取name
*
* @return 名称
*/
public String getName() {
return name;
}
}
执行以下命令就可以生成javaDoc文档
//-encoding UTF-8 设置编码格式
//-charset UTF-8 设置字符集格式 防止中文乱码
javadoc -encoding UTF-8 -charset UTF-8 Doc.java
执行后就可以生成一些文件
以下就是生成的Doc的文档