JavaDoc
创建文档注释
-
javadoc命令是用来生成自己API文档的
-
参数信息
- @author 作者名
- @version版本号
- @since指明需要最早使用的jdk版本
- @param参数名
- @return返回值情况
- @throws异常抛出情况
package com.Tian.base;
/** 类注释
* @author Tiancai 作者
* @version 1.0 版本
* @since 1.8 java版本
*/
public class Doc {
String name;
/**
* author Tiancai 作者
* @param name 参数名
* @return 返回值情况
* @throws Exception 异常抛出情况
*/
pub1ic String test(String name) throws Exception{
return name ;
}
通过命令行生成API文档
- 打开文件所在目录的命令行
- 命令格式 javadoc 参数 java文件
- 输入命令 javadoc -encoding UTF-8 -charset UTF-8 java文件名
- 生成API文档