文档注释
文档注释一般标注在类、接口、方法上，用于对类、接口、方法进行说明。
/**
* 文档注释
*/
类、接口上常用的标注
/**
* 操作数据库的工具类 #对类|接口进行说明，可以使用html标签，但使用单标签时不能自己关闭，比如<br />只能写成<br>
* @author chy [email protected] #此部分代码开发者的信息、联系方式
* @version 1.0 #版本
* @deprecated #不推荐使用
* @see conf.DbConfig #另请参阅，链接到其它类|接口的文档
*/
public class DbUtil {
}
方法上常用的标注
/**
* 根据用户id查询对应的用户名 #对方法整体的说明，一般是方法功能
* @deprecated #不推荐使用
* @param username 用户名 #参数含义
* @param password 密码
* @return 受影响的记录数。插入成功返回1，插入失败返回0
* @throws IOException #抛出的异常
* @exception IOException #也可以用此标记来说明抛出的异常
* @see conf.DbConfig #另请参阅
*/
public Integer addUsernameById(String username,String password) throws IOException{
}
生成API文档
使用IDEA提取API文档
Tools -> Generate JavaDoc -> 勾选所需选项，设置输出目录、参数
Locale：zh_CN
指定API文档的语言代码，缺省时默认为操作系统使用的语言，大陆是简体中文
Other command line arguments：-encoding UTF-8 -charset UTF-8
设置命令行参数，第一个表示源文件编码字符集是utf-8，第二个指定要生成的API文档的编码字符集是utf-8
IDEA提取实际是调用javadoc命令
命令行参数
-
IDEA debug | run
-
命令行运行jar包
java -jar xxx.jar 参数1 参数2 参数3
参数以字符串数组的形式传入，不引