IDEA 設置注釋模板

在進行開發的時候,尤其是在公司進行代碼開發的時候,在你的代碼上一般都要加上注釋,常見的就是你的名稱、創建日期、類的描述等,name如何去定義自己的注釋模板呢?

設置類的模板

IDEA 中可以進行自己模板的定義。按照File--> Settings --> Editer-->>File and Code Templates-->Files中打開設置頁面:

image.png

這里我們主要關注 Class、Interface、Enum 者幾個模板的設置,因為我們平時主要用到著三個。選中Class 可以看到右面的默認的模板,我們可以這樣去替換他:

/**
 * @Auther: ${USER}
 * @Date: ${DATE} ${HOUR}:${MINUTE}
 * @Description: ${NAME}
 * @Version 1.0.0
 */
image.png

其他的兩個設置相同,然后點擊OK就可以。

測試一下

image.png

發現是可以的。

設置方法的注釋

IDEA沒有可以直接設置方法注釋模板的地方,可以借用Live Templates基本實現,步驟如下。

首先創建模板組

選擇File–>Settings–>Editor–>Live Templates,先選擇右側綠色加號新建一個自己的模板組,如圖,命名為methodTemplate


image.png

選中已建好的組,選擇右側綠色加號新建模板,如下圖。

image.png

填寫的模板為
注意這里的是*而不是 /*開頭,因為這樣才能比較好的使用我們定義的去實現模板,不然的話,最后的模板會有問題,很丑。

*
 *
 * @description: 
 * @param: $param$
 * @return: $return$
 * @date: $date$ 
 */
image.png

點擊那個Define,然后勾選使用的場景,這里我們勾選Java就行了。


image.png
image.png

然后點擊Edit variables 進行如下的設置:


image.png

最后點擊OK 就行了。

補充說明

image.png

這里的Expand with 是你輸入快捷鍵后的按鍵,也就是你輸入/**之后,你要按Tab鍵才能使用上面設置的模板,當然這個鍵可以你自己去設置。

測試驗證

image.png

成功!!!

結語

如果本文章對你有所幫助的話,請幫忙點個贊!!!

?著作權歸作者所有,轉載或內容合作請聯系作者
平臺聲明:文章內容(如有圖片或視頻亦包括在內)由作者上傳并發布,文章內容僅代表作者本人觀點,簡書系信息發布平臺,僅提供信息存儲服務。