IDEA設定類注釋和方法注釋模板

2021-10-18 16:30:57 字數 2009 閱讀 5318

很多公司或組織都有各自的**注釋規範,我們每新建類或者方法的時候如果每次重新寫或者從以前的地方複製貼上過來很麻煩,而且很容易出錯。那麼,設定類注釋和方法注釋模板就應運而生啦!其實,大家都知道,在idea中輸入sout+enter鍵,就會變成system.out.print(),輸入psvm,就會變成public static void main (string args){},其實,這也是模板的作用。

一,類注釋模板

步驟:

講解:如上圖,紅的的大框裡的內容為我們新建乙個類的時候自動生成的**:

預設生成包路徑:

預設生成類的框架:

類注釋(綠色框框):

*/大家有沒有注意到@data後面有預設值,這些其實我們可以在底下綠色框框的位置檢視的

意味著填寫了$就能獲取系統的時間了

二、方法注釋模板

步驟:file-->settings-->editor-->live templates-->+-->template group-->create new group-->選擇剛剛新建的模板分組-->live templates

1、abbreviation:模板縮寫

2、description:模板描述

/**

* 功能描述

*$param$

* @return $return$

* @author

* @since $date$ $time$

*/

注意:這個步驟很重要,一定要記得設定(我不會跟你萌說我踩過坑,設定完之後沒有效果,找了好久原因)

5、編輯模板中的引數

該設定中的name與第三條的引數一一對應

default value中是預設值,和類注釋中的預設值同理

param設定為(能自動獲取引數值):

groovyscript("def result=''; def params=\"$\".replaceall('[\\\\[|\\\\]|\\\\s]', '').split(',').tolist(); for(i = 0; i < params.size(); i++) ; return result", methodparameters())

1

6、1(abbreviation)與6組合成為生成方法注釋的快捷鍵

如上,我們的類模板和方法模板就設定好了。

idea 類注釋,方法注釋設定

類頭注釋 開啟file setting editor filr and code templates includes file header 直接在右邊的檔案框裡編輯你說需要注釋的東西,然後應用儲存之後,當你建立類的時候就會自動生成注釋。方法注釋 開啟file setting editor liv...

idea設定類注釋和方法注釋模板

這樣在定義類時,都要多輸入類的描述。不想的話,可以刪去 功能描述 功能描述 即 groovyscript def result def params replaceall s split tolist for i 0 i params.size i return result methodparam...

IDEA 生成類注釋和方法注釋

目錄 二 生成類注釋 02 三 兩種類注釋生成的區別 四 生成方法注釋 classname j a author 建立人名稱 version 1.0.0 description todo createtime 年 月 日 依次開啟file settings editor file and code ...