JavaDoc文档注释使用规范

文档注释类

@author 作者
@version 版本

注释方法

@param：参数
@return：返回值

注释实例

• 单行注释:

//注释内容 或者 /**注释内容**/

• 多行注释：

/*
这里是多行
注释内容
*/

注意：上两种的注释方式是不会添加到javadoc文档中的

• 文档注释：能够生成javadoc文档的注释

类的文档注释：

/**这里是描述
*@author 这里是作者
*@version 这里是版本
*/

方法的文档注释：

/**这里是描述
*@param 这里是参数
*@param 这里是参数
*@return 这里是返回值
*/