在代码标准语义编写之上，为了使代码更加规范，代码可读性高，我们可以添加标准和统一的注释规则来，约束自己的代码风格。目前我们都是用idea开发工具开发，所以下面是通过idea设置的注解模板：
类注解：
模板如下
设置如下：
File–>settings–>Editor–>File and Code Templates–>Includes
选择file header
/**
* XXXXXXXXX科技有限公司 版权所有 © Copyright 2018<br>
*
* @Description: <br>
* @Project: hades <br>
* @CreateDate: Created in ${DATE} ${HOUR}:${MINUTE} <br>
* @Author: <a href="abc@qq.com">abc</a>
*/
如上，文件头的注解模板就设置完成了，你只需要新建一个文件，文件头自动回生成注解
方法头注解
模板如下
设置如下：
File–>settings–>Editor–>Live Templates
选择MyGroup,然后添加 Live Template
插入代码块
/**
$params$
* @Return: $return$
* @Decription:
* @CreateDate: Created in $date$ $time$
* @Author: <a href="wuchangyi@quannengzhanggui.com">wcy</a>
* @Modify:
*/视图
然后点击Edit variables
添加属性
params groovy 脚本参数设置：
groovyScript("def result=''; def params=\"${_1}\".replaceAll('[\\\\[|\\\\]|\\\\s]', '').split(',').toList(); for(i = 0; i < params.size(); i++) {result+=' * @param: ' + params[i] + ((i < params.size() - 1) ? '\\n\\b' : '')}; return result", methodParameters())设置完成!
其他注释
属性
注释
/**
*
*/
代码块单行
注释
//
代码块多行
注释
/**
*
*/
使用：代码五行左右一定要有一个注释。所有变量名都添加一个注释，有歧义的都需要添加注释。