【注释规约】规范化的第一步，你类和方法的注释，规范嘛？

一、class注释

创建class类的时候，生成注释规约

【类型1】

/**
  * @ClassName: ${NAME}
  * @Description: TODO
  * @Author: ffideal
  * @Date: ${DATE} ${TIME}
  * @Version: v1.0
  *
  */

【类型2】

/**
 * @ClassName   :   $NAME$
 * @author      :   ffideal
 * @Description :   TODO(用一句话描述该类做什么) 
 * @projectname :   
 * @version     :   1.0
 * @DATE        :   Created in $TIME$ $DATE$
 * <pre>       Copyright: Copyright(c)2019     </pre>
 * <pre>       Company :   			           </pre>
 * Modification  History:
 * Date         Author        Version        Discription
 * --------------------------------------------------------------------------
 * $DATE$       ffideal        1.0       Why & What is modified: <修改原因描述> * 
 */

Step 1

File -> Settings -> File and Code Templates -> Includes -> File Header ->文本框中将上面的注释添加进去 ->OK

二、method注释

【类型1】

/**
 * @Description: $description$方法是
 * @param: $param$
 * @return: $return$
 * @auther: ffideal
 * @date: $date$ $time$
 */

Step 1

Settings -> Live Templates -> Template Groups

Step 2

创建一个新组，并输入新组的名称

Step 3

生成完毕后

Live Templates -> 点击新组，单击右侧的“+”号 -> 选择Live Template -> 4 -> 5 -> 填入相关的context

Step 4

点击“Edit variable” ->输入如下

Name	Expression
Param	methodParameter()
return	methodReturnType()
description	methodName()
date	date()
time	time()

Step 5

在界面下方Define -> 勾选 Java

Step 6

使用方法：

创建方法，在方法上一行，输入 / ，然后回车

Step 7

大功告成