【Java】注释

注释要求

注释是帮助程序读者的一种手段在编码的过程中必须随时加注释，不能过后补齐。通过注释描述当时的思路，以及悬而未决的问题；提高程序的可读性，规范性，维护性。提供使用说明、及配置信息。

1.每行注释不超过40个中文字；
2.每个类、接口的开头必须多行的详细的功能说明，使用中文注释，包括作者、版本、创建时间等等；
3.每个方法前面都必须使用Javadoc的中文注释，必须说明该方法的作用与目的；
4.每个成员变量必须有单行中文注释，必须说明该成员变量的作用与目的。

类注释

/*** 作者：小码匠
* 功能：现存量业务逻辑
* 日期：2020-05-27
*/

方法注释

方法头注释必须包括：方法执行了什么功能，为什么要这样处理；方法处理过程中对对象的那些属性可能进行更改；方法执行前后，对象的状态。

1.比较、循环等控制结构必须加注释；
2.在代码的功能并非一目了然的情况下，应当说明为什么要这样做；
3.局部变量必须加注释；
4.复杂难写的代码必须加注释；
5.如果一系列代码的前后执行顺序有要求，必须注释说明 方法开头需要的注释内容：作者、功能、参数说明、返回值、例外、日期、修改日期，修改人，修改原因。举例：

/*** 作者：小码匠
* 功能：查询现存量
* 参数： voCond：查询条件VO