先看下效果:
紅色框裏的內容需要自己手動填寫。其他是我們設置好的模版
一:生成類註釋
1、File-->settings-->Editor-->File and Code Templates-->Files-->Class
藍色框裏面的內容就是我們需要設置的註釋模版,填好模版,單OK,完成。
註釋模版:
/**
* @program: ${PROJECT_NAME}
*
* @description: ${description}
*
* @author: Mr.Wu
*
* @create: ${YEAR}-${MONTH}-${DAY} ${HOUR}:${MINUTE}
**/
program:自動獲取項目名字。
description:對這個類的說明。
每次創建類時會有兩次彈框,第一次輸入類名字,第二次是讓你輸入description的內容,也就是對這個類的說明。
author:這個類的創建者,這裏可以寫上自己的名稱。
create:這裏自動獲取創建類的時候。
假設現在創建一個DateUtil類,創建類時會有兩次彈框,如圖
效果:
如果我不想在創建類的時候有兩次彈框,網上也有很多都是在Includes的File Header裏面添加(自行百度),在這裏面添加還需要自己去移動下鼠標,然後再去操作鍵盤,再去寫description,,直接在創建類的時候就添加好description不更快嗎?
二:生成方法註釋
打開file->setting->Editor->LiveTemplates點擊右邊上面那個綠色的+號,選擇Template Group雙擊,然後彈出一個窗口,隨便添加一個名字,我這裏添加的是AAA然後點擊OK
藍色框框裏的Tab是我們創建方法後,想插入註釋時的快捷鍵,可根據自己的習慣更改,我未更改。
還是在file->setting->Editor->LiveTemplates這個路徑下點擊一下剛剛你添加的那個名字(我這是AAA),然後點擊右邊上面那個綠色的+號,選擇LiveTemplate雙擊
填寫下面圖上的框
操作第4步單擊Change會出現下面彈框,勾選Everywhere
操作第5步彈出下面彈框,按圖操作(注意,有下拉框,可以選擇,免的自己輸入時筆誤)。
到此,方法註釋模版設置完成,現在實際操作一下。
在剛纔創建的DateUtil類下創建一個方法,在方法裏輸入a(這裏的a是前面自己設置的),然後按下Tab鍵,這時就會生成方法註釋
(注意:a需要和方法裏輸入 ,生成的註釋也會在方法裏,手動移動到方法外,如果a輸在方法外面,是沒辦法獲取到方法參數的,這個可以自己試試)
下面自己把各參數的含義補全,把註釋移動到方法外面,如圖: