在IntelliJ IDEA中设置类、方法注释

在IntelliJ IDEA中设置类、方法注释

1、设置类注释：

• 1、 打开file->setting->Editor->Filr and Code Templates->Includes->File Header
  
• 2、选择File Header，然后右边是显示：
  

    /**     
      * java类简单作用描述
      * @ProjectName:    ${PROJECT_NAME}
      * @Package:        ${PACKAGE_NAME}
      * @ClassName:      ${TYPE_NAME}
      * @Description:     java类作用描述 
      * @Author:         作者姓名
      * @CreateDate:     ${DATE} ${TIME}
      * @UpdateUser:     Neil.Zhou
      * @UpdateDate:     ${DATE} ${TIME}
      * @UpdateRemark:   The modified content
      * @Version:        1.0
      * <p>Copyright: Copyright (c) ${YEAR}</p>
      *
      */

修改后，点击OK，当你再次创建类的时候就会自动生成注释；

2、设置方法注释

打开file->setting->Editor->LiveTemplates

• 1、点击右边上面那个绿色的+号，选择Template Group双击；

• 2、弹出一个窗口，添加一个分组名字，我这里添加的是docGroup，然后点击OK ；

• 3、点击一下刚刚你添加的那个名字（docGroup），然后点击右边上面那个绿色的+号，选择LiveTemplate双击

• 4、 出现下面的场景，如图：

• 5、定义cmt为类注释、mcmt为方法注释两个自定义快捷键生成注释模板；
  
  具体信息如下：
  cmt=====》

    /**
     *  java类简单作用描述
     * @ProjectName:    $PROJECT_NAME$
     * @Package:        $PACKAGE_NAME$
     * @ClassName:      $TYPE_NAME$
     * @Description:    java类作用描述
     * @Author:         作者姓名
     * @CreateDate:     $DATE$ $TIME$
     * @UpdateUser:     作者姓名
     * @UpdateDate:     $DATE$ $TIME$
     * @UpdateRemark:   The modified content
     * @Version:        1.0
     * <p>Copyright: Copyright (c) $YEAR$</p>
     *
     */

mcmt===》

    /**
     * 方法实现说明
     * @method      $method$
     * @author      作者姓名
     * @version     $version$
     * @see         对类、属性、方法的说明 参考转向
     $param$
     * @return      $return$
     * @exception   $exception$
     * @date        $date$ $time$
     */

注意命令生成和类文件定义的不同，有些变量需要设定；
具体如下：

• 1、cmt需要设置的变量，Expression可以选择：
  

• 2、mcmt需要设置的变量，Expression可以选择：
  

• 3、需要注意的是，@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\\b' : '')}; return result", methodParameters())

基本设置完成，可以试试啦！