JAVA程序员日常编码遵守注释规范

​        早在2017年9月25日阿里巴巴发布了第一版的Java开发手册，到现在也已经有4个版本了，分别是2017（终极版），2018（详尽版），2019（华山版）和2020（泰山本）。其中有条就是注释规约。这样不仅避免代码整理时容易发生的争执。而且在统一的注释规范，大家互相看着也方便。更重要的是也会养成一个良好的习惯。

首先推荐一款idea插件：

一、 Alibaba Java Coding Guidelines插件

介绍：这款插件可以在日常写代码中检测不合适的代码自动提示帮助我们及时更正养成良好的编码习惯。

下载步骤：

打开File----->Setting----->Plugins界面，搜索Alibaba，如下图
点击installed安装。我这里已经安装过了，所以是灰色按钮，正常第一次安装之后他会提示重启idea生效。

二、类注释

       在你下载完插件之后，他会对你的代码进行扫描，不合规范的会用黄色波浪线提示。而接下来我们每次创建一个类的时候，如果没有类注释的话你的类名就会有黄色波浪线提示。

如图，比如创建一个User类：

它会提示User类缺少作者的注释信息。遇到这种情况，我们可以创建一个类注释模板。

创建类注释模板：

（1).打开File----->Setting----->Editor----->File and Code Templates界面，点击Class，如图：

（2).复制以下代码到模板中

/** 
* @Description: TODO
* @author: baiyixiao
* @date: ${YEAR}-${MONTH}-${DAY} ${TIME}
*/

@author选项，写个人作者署名，入下图：

点击Apply，然后点击OK。这样我们接下来每次创建类他就会自动跟类创建好。

也没有再有黄色波浪线了。

三、方法注释

       和类一样，每个方法上都要求有Javadoc注释，注释内容要求返回值有类型，参数，方法描述说明。

创建方法注释模板：

（1).打开File----->Setting----->Editor----->Live Templates界面，点击右侧的＋号按钮，选择Template Group选项。

（2).在弹出的界面中新建一个为MyGroup的选项，点击OK。

（3).再次点击右边＋号按钮，选择Live Template选项。

（4).将下面这段注释复制：

**
 * description: 
 * 
$param$ 
 * @return $return$
 */

（5).

• 设置快捷键
• 复制内容到Template text里
• 切换Expend with为Tab
• 点击Edit varibles
  
  (6).复制param要填入的表达式：

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' : '')}; 
            return result ", methodParameters())

   (7).

• 1.将上面param表达式复制到Exprrssion里
• 2.return的Exprrssion选择methodReturnType()选项
• 3.Skip if defined里面都勾选对号。
• 4.点击OK。
  
  (8).再次点击OK。
  
  (9).在方法上输入/*+Tab键：
  
  这样就完成了。

         这样在每次编码时候，都去给类，方法，接口都做一个注释，是真的会养成一个很好的编程习惯。