JavaDoc
-
javadoc命令是用来生成自己API文档的
参数信息
-
@author 作者名
-
@version 版本号
-
@since 指明需要最早使用的jdk版本
-
@param 参数名
-
@returm 返回情况
-
@throws 异常抛出情况
package com.rong.base;
/**
* @author xiaotang
* @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;
//通过Dos命令窗口,数入javadoc 参数 java文件,可成javadoc文档(参数:-encoding UTF-8 -charset UTF-8)
}
}
package com.rong.base; /** * @author xiaotang * @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; //通过Dos命令窗口,数入javadoc 参数 java文件,可成javadoc文档(参数:-encoding UTF-8 -charset UTF-8) } }