IDEA设置类注释、方法注释

妖狐艹你老母 2022-09-04 02:47 201阅读 0赞

### 文章目录 ###

*   *   *  一、概述
         *  二、类注释
         *  三、方法注释

### 一、概述 ###

> IDEA不能像Eclipse一样直接导入xml设置代码模板。

### 二、类注释 ###

> 1.每个类头部必须加：**用途：**  
> 2.每个类上方必须写明以下注释（逆向生成的不用写）

/** * 用途: TODO * * @author: ADAM * @create: ${YEAR}/${MONTH}/${DAY} ${HOUR}:${MINUTE} * @version: 1.0 */

**快捷方式：**  
【Preferences】-> 【Editor】 -> 【File and Code Templates】-> 【File】-> 【Class】 覆盖、【Interface】引入

#if (${PACKAGE_NAME} && ${PACKAGE_NAME} != "")package ${PACKAGE_NAME};#end
    #parse("File Header.java")
    
    /**
    * 用途: TODO
    * 
    * @author: ADAM
    * @create: ${YEAR}/${MONTH}/${DAY} ${HOUR}:${MINUTE}
    * @version: 1.0
    */
    public class ${NAME} {
    }

### 三、方法注释 ###

> 1.每个方法前面必须加：**功能：**  
> 2.接口层所有方法和类内部方法必须写注释  
> 3.切记不要加/ 否则methodParameter方法获取不到值

*
     * 功能：TODO
     * 
    $PARAMS$
     * @return: $RETURN$
     * @author: ADAM
     * @date: $DATE$ $TIME$
     */

**快捷方式：添加快捷键**

*  1.创建模板组  
    【Preferences】-【Editor】-【Live Templates】-【+】-【Template Group】- ADAM -> 快捷键【\*】
    
     *  方法注释快捷生成
        
        <table> 
         <thead> 
          <tr> 
           <th>键</th> 
           <th>值</th> 
          </tr> 
         </thead> 
         <tbody> 
          <tr> 
           <td>Abbreviation（快捷键）</td> 
           <td>*</td> 
          </tr> 
          <tr> 
           <td>Description（描述）</td> 
           <td>方法注释快捷生成</td> 
          </tr> 
          <tr> 
           <td>Template Text（代码块）</td> 
           <td>详见上面</td> 
          </tr> 
          <tr> 
           <td>Applicable（应用于）</td> 
           <td>Java</td> 
          </tr> 
         </tbody> 
        </table>
     *  Edit variables
        
        > 将代码块中的变量映射到表达式：自动定义类名
        
        <table> 
         <thead> 
          <tr> 
           <th>Name</th> 
           <th>Expression</th> 
           <th>Default value</th> 
          </tr> 
         </thead> 
         <tbody> 
          <tr> 
           <td>PARAMS</td> 
           <td></td> 
           <td>groovyScript脚本见下</td> 
          </tr> 
          <tr> 
           <td>RETURN</td> 
           <td>methodReturnType()</td> 
           <td></td> 
          </tr> 
          <tr> 
           <td>DATE</td> 
           <td>date()</td> 
           <td></td> 
          </tr> 
          <tr> 
           <td>TIME</td> 
           <td>time()</td> 
           <td></td> 
          </tr> 
         </tbody> 
        </table>
        
        groovyScript:
        
            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())
     *  Options
        
        **Expand with : Enter**
 *  2.使用

输入/\*\*回车