文档注释--JavaDoc

文档注释--JavaDoc

javadoc是用来生成代码的帮助文档的。

 

格式：

/**
 *@auhor li
 *@version 1.0
 *@since 1.8
 */

 

文档注释可写的参数信息：

• @author 作者名

• @version 版本号

• @since 指明需要最早使用的jdk版本

• @param 参数名

• @return 返回值情况

• @throws 异常抛出情况

 

javadoc生成命令

javadoc -encoding UTF-8 -charset UTF-8 xxx.java