1. 程式人生 > 其它 >idea類和程式碼註釋模板配置

idea類和程式碼註釋模板配置

一、IDEA自動新增檔案頭註釋

1、   開啟IDEA

2、   選擇File-->settings-->Editor-->File and Code Templates-->Files

3、   選擇Class檔案(當然你要設定介面的還也可以選擇Interface檔案)

4、   進行配置

模板格式為:

/******************************
* 用途說明:
* 作者姓名: ${USER}
* 建立時間: ${DATE} ${TIME}
******************************/

(1)     用途說明:用途說明的標記,一般生成類或方法都需要手動新增描述

(2)${USER}:設定建立類的作者姓名

(3)${DATE}、${TIME}:設定建立的日期和時間

二、 IDEA新增方法註釋

1、   選擇File-->Settings-->Editor-->Live Templates

2、   新建組:點選視窗右側的+,選擇Template group命名為myGroup

3、新建模板:選擇新建立的組myGroup,點選視窗右側的+,選擇Live Template

4、設定模板:填好Abbreviation(快捷輸入),Description(描述)和Template text(模板內容)

模板內容如下

標記1:模板的名稱,與頁面使用時快捷鍵有關,建議使用*

標記2:模板的註釋,可任意設定,可以為空

標記3:註釋的模板,模板如下:

**********************************
* 用途說明:
$params$
* 返回值說明: $return$
***********************************/

5、設定引數對應的獲取方法

標記4:設定引數的獲取方式

選擇右側的Edit variables按鈕

params的引數需要設定為

groovyScript("def result=''; def params=\"${_1}\".replaceAll('[\\\\[|\\\\]|\\\\s]', '').split(',').toList(); for(i = 0; i < params.size(); i++) {result+='* 引數說明 ' + params[i] + ((i < params.size() - 1) ? '\\n':'')}; return result", methodParameters())

6、點選Define,勾選Java

標記5:設定模板的應用場景

點選模板頁面最下方的警告,來設定將模板應用於那些場景,一般選擇EveryWhere-->Java即可