checkstyle 代码检查规范@注释 出现的顺序 记录

记录@标签应按以下顺序出现：

@author, @version, @param, @return, @throws, @exception, @see, @since, @serial, @serialField, @serialData, @deprecated

 

具体解释

@author //作者

@version //版本

@param //参数

@throws //可能会被抛出什么样的错误

@exception //异常类型

@see //对于这个标记，javadoc会生成相应的HTML，将其直接链接到其他文档

@since //标明一个类，方法，或其它标识符是在哪个特定版本开始添加进来的

@serial  //未查到  欢迎补充

@serialField // 同上

@serialData // 同上

@deprecated  //表示此方法已废弃、暂时可用,但以后此类或方法都不会再更新、后期可能会删除,建议后来人不要调用此方法