IntelliJ Idea注釋模板--類注釋、方法注釋


剛從Eclipse切換到IntelliJ Idea,之前使用eclipse時用到了注釋模板,包括類注釋和方法注釋,現在分別講一下在Intellij Idea中如何進行配置,作為備忘

一. 類注釋模板配置

1. 配置效果

2. 配置方法

 【File】-->【settings】-->【Editor】-->【File and Code Templates】-->【Files】-->【Class】

 

一. 類注釋模板配置

 1. 配置效果

 

注意:關於參數的注釋,網上有一些配置是將多個參數列在一行,形如:@param [a, b]當然網上也提供了將多個參數列成多行的形式,即上圖所示效果,這是用腳本實現的,但是網上的腳本因空格問題,老是對不齊,本人有強迫症,修改了一下(起始就是去了個空格),使之對的比較整齊,如上圖所示效果。

 

2. 配置方法

IDEA還沒有智能到自動為我們創建方法注釋,這就是要我們手動為方法添加注釋,使用Eclipse時我們生成注釋的習慣是:/**+Enter,這里我們也按照這種習慣來設置IDEA的方法注釋。

(1)打開頁面配置

 

(2)創建模板組

【Editor】 --> 【Live Templates】 --> 【點擊“+”】 --> 【Template Group】 --> 【輸入名稱,點擊OK(我輸入的是My Group)】,如下圖中步驟1~4

 

(3)創建模板

        選中新建的模板組(My Group) --> 點擊“+” --> 1.Live Template,如上圖中步驟5~6

 (4)模板設置:

  •   1.設置模板前綴,如果設置為,使用時 /* + Enter鍵(第5步設置該按鍵),如果設置為a,使用時 /*a + Enter鍵,其他類推
  •   2.設置該模板應用范圍,mothed表示方法,file表示類上面
  •   3.填寫模板內容,具體內容會在后面補充,可以參考
  •   4.設置模板中變量的取值
  •   5.設置執行按鍵,默認是Tab,我一般習慣改為Enter鍵。該功能主要配合步驟1中的模板前綴使用
  •   6.設置模板應用范圍,一般是點擊第一個進行全選操作。

 

(5)模板內容

  設置模板內容,如上圖步驟3位置所示:

*
* @Description TODO
$params$
* @Return $return$
* @Author duzhijie
* @Date $date$ $time$
**/

 

(6)設置模板變量的取值,對應上圖步驟4操作,如下

         在這里設置模板變量取值,或者用腳本,或者用idea自帶的方法,如 

  方法參數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) ? '\\r\\n' : '')}; return result", methodParameters())

注意:只有用這個腳本,多個參數才是才是各占一行,如果用 methidParameters(),則多個參數會只占一行,形如:@param [a, b], 

 


免責聲明!

本站轉載的文章為個人學習借鑒使用,本站對版權不負任何法律責任。如果侵犯了您的隱私權益,請聯系本站郵箱yoyou2525@163.com刪除。



 
粵ICP備18138465號   © 2018-2025 CODEPRJ.COM