idea設置方法注釋


1、給創建的文件自動添加注釋信息

/**
 * @ClassName: ${NAME}
 * @Description: 
 * @Author: ${USER}
 * @Date: ${DATE} ${TIME}
 */

  

 

 

 2、idea方法注釋,系統默認的只能獲取到參數,無法獲取返回值,如下:

   /**
     * 
     * @param id
     * @param type
     * @return
     */
    public static String getName(Long id, int type) {
        return null;
    }

  

使用Eclipse時我們生成注釋的習慣是/**+Enter,這里我們也按照這種習慣來設置IDEA的方法注釋

1. File-->Settings-->Editor-->Live Templates

 

 

 

1.1 新建Template Group: 命名為 MethodBingtai

 

1.2 在MethodBingtai下新建Live Template,命名為*

 

 

 

 

 

 

 

 

 

 

因為IDEA生成注釋的默認方式是:/* +模板名+快捷鍵(比如若設置模板名為add快捷鍵用Tab,則生成方式為/*add+Tab),如果不采用這樣的生成方式IDEA中沒有內容的方法將不可用,例如獲取方法參數的methodParameters()、獲取方法返回值的methodReturnType()

作者:味道_3a01
鏈接:https://www.jianshu.com/p/2b17c3879879
來源:簡書
著作權歸作者所有。商業轉載請聯系作者獲得授權,非商業轉載請注明出處。

  

1.3 設置注釋的快捷鍵

 

 

1.4 設置模板

模板內容如下:

*
 * 功能描述: <br>
 * 〈$END$〉
 * @Param: $param$
 * @Return: $return$
 * @Author: $user$
 * @Date: $DATE$ $TIME$
 */

  

注意 第一行,只有一個* 而不是/*

在設置參數名時必須用$參數名$的方式,否則1.5中讀取不到你設置的參數名

1.5 設置參數的獲取方式

選擇右側的Edit variables按鈕

 

 

 

 選擇每個參數對應的獲取方法(在下拉選擇框中選擇即可),網上有很多教程說獲取param時使用腳本的方式,我試過使用腳本的方式不僅麻煩而且只能在方法內部使用注釋時才能獲取到參數

 

 

 

 選擇應用場景:勾選Java

 

 

 

 

注意 點擊模板頁面最下方的警告,來設置將模板應用於那些場景,一般選擇Java即可(如果曾經修改過,則顯示為Change而不是Define

再次選擇右側的Edit variables按鈕,下拉框就有選項了;如下圖,選中對應的Expression,點擊OK

 

 

2. 效果

創建方法,在方法上一行,輸入 /** ,然后 回車

 

 



IDEA中設置注釋模板的方法

 

  IDEA中設置注釋模板主要分為兩個部分,分別是創建java文件時類的注釋和方法的注釋。

  這里為大家詳細介紹一下方法,按MyEclipse的風格設置(MyEclipse的請看:MyEclipse中設置注釋模板的方法),大家可以根據自己的習慣生成自己喜歡的注釋模板。效果如下:

 

 

一、設置類的注釋模板

1、選擇File→Settings→Editor→File and Code Templates→Files→Class。可以看到創建Class時引入了一個參數"File Header.java"。對應的是Files旁邊的Includes→File Header文件。

 

2、File Header里就是創建類時的注釋模板,下面Description中有描述一些可以配置的參數,可以根據自己需要選用。

 

二、設置方法的注釋模板

1、選擇File→Settings→Editor→Live Templates。點擊右邊的加號,選擇Template Group,創建一個分組。

 

2、再點擊加號,選擇Live Template,創建一個模板。其中:

Abbreviation:填模板的縮寫,可以使用*號作為代號,方便后面調用模板。

Options→Expand with:填注釋模板的擴展快捷鍵,根據使用習慣,這里使用默認的Tab。

Template text:填寫注釋模板的內容。參數名使用${參數名}$的格式。(注意:注釋模板開頭的/不要填寫,原因可以看文章末尾的解釋)

 
           

 

3、點擊模板頁面最下方的警告define,來設置將模板應用於哪些場景,選擇Everywhere-->Java即可。(如果曾經修改過,則顯示為change而不是define,如上圖)

 

4、然后點擊Edit variables,會讀取剛剛在注釋模板中的配置的參數${參數名}$。在Expression的下拉框中選擇方法為其賦值。

 

5、參數賦值優化

(1)如果param參數使用默認的methodParameters()來獲取方法參數值,其注釋參數是在一行展示的,如下圖。這里我們希望像MyEclipse中一樣,一行一個參數的樣式,可以通過腳本來實現。將以下腳本復制進Expression,可以得到文章開頭效果圖的樣式:

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())

 

(2)如果return參數使用默認的methodReturnType()來獲取參數值,模板里使用了@link來跳轉結果類型,那么當方法返回值為void時,注釋會報錯,如下圖。可以通過腳本來避免,將上面模板中的@link參數去掉,將以下腳本復制進Expression:

groovyScript("def result=\"${_1}\"; if(result == \"void\"){return \"\";}else{return \"{@link \"+result+\"}\";}", methodReturnType())

 

6、注釋模板的調用。通過輸入 / + * + Tab鍵,即先輸 /* 再按Tab鍵,就可以調用模板。因為剛剛我們把*被設置為模板的代號,Tab鍵設置為模板的擴展快捷鍵,也可以把Tab改為Enter鍵,更加還原MyEclipse。

 

PS:(1)注意,注釋模板開頭不要使用/,因為設置后雖然可以更便捷的使用 * + Tab鍵,調用模板。但是會存在param為null的情況(原因暫時未知),如下圖,需要在方法內調用才能獲取參數,但這樣還需要將注釋復制到方法外反而使用不便。

 

(2)注釋模板中的user參數是獲取系統的用戶(當然注釋作者也可以直接寫固定值,但是配置更有意思,哈哈),經常不是自己需要的作者名,可以在IDEA中進行配置。打開→IDEA的安裝目錄\bin\idea64.exe.vmoptions。在最下面增加一行-Duser.name=username。

其中username就是你希望為user參數的賦值。

 

(3)注釋模板中的date參數是獲取系統的時間及格式(即桌面右下角的時間及格式),而WIN10下系統時間格式是可以調整的。右鍵桌面右下角的系統時間→調整日期/時間→日期、時間和區域格式設置→更改數據格式→調整“短日期格式”。

 


免責聲明!

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



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