java中的注释

Javadoc

用于描述类或者方法的作用。Javadoc可以写在类上面和方法上面。

标记	用于	作用
@author	对类的说明	表明开发该类的作者
@version	对类的说明	标明该类的版本
@see	对类、属性、方法的说明	参考转向
@param	对方法的说明	对某参数的说明
@retrun	对方法的说明	对返回值的说明
@exception	对方法的说明	对可能抛出的异常说明

文档注释的内容可以通过 javadoc 的指令被编译到帮助文档中。
通过IDEA生成Javadoc： Tools --> Generate JavaDoc -->

其他常见约定标记：
@data 编写时间

使用规范

• java文件：描述、版本、时间、作者
• 类/接口：描述、版本、作者
• 方法：描述、参数、返回值
• 变量/属性：描述
• 算法：描述
• 判断：描述
• 业务：描述

良好的注释编写习惯可以提高代码的可读性。