小編給大家分享一下IDEA類和方法注釋模板設置的示例分析，希望大家閱讀完這篇文章之后都有所收獲，下面讓我們一起去探討吧！
idea 模版之自定義類與方法注釋
很多公司都有要求的代碼注釋規范，我們每新建類或者方法的時候從新復制粘貼很麻煩，而且容易粘錯。
當然自定義模板還可以用到很多地方，比如系統自帶的 sout就是system.out.print(); 當你輸入某文本的時候，系統會自動替換成目標文本。
1定義java文件頭部的注釋
2給java類中的方法添加上注釋
2.1第一步勾選Enable Live Templates
2.2第二步新建一個Group
2.3第三步新建一個Template
2.4第四步點擊Define按鈕
2.5第五步填寫注釋模板
1、定義java文件頭部的注釋
打開設置面板，然后填寫注釋模板：
File => setting => editor => File and Code Templates
如圖：
2、給java類中的方法添加上注釋
2.1、第一步勾選Enable Live Templates
首先要在上一章節的圖中勾選中 Enable Live Templates
如圖：
2.2、第二步新建一個Group
其次要打開LiveTemplates 然后新建一個Group
如圖：
在彈窗口中輸入你想要的group名稱，例如我取名叫chenjieGroup
如圖：
點擊OK，你已經新建了一個模板組，名稱叫chenjieGroup
如圖：
2.3、第三步新建一個Template
選中新建的group，也就是選中chenjieGroup，在這個group下新建一個LiveTemplate
如圖：
上圖中點擊Live Template之后，將會新建一個模板，并且光標定位到了需要你輸入快捷鍵的方框中
如圖：
我輸入了cjm意思是當我在java文件的某個方法內部，連續輸入cjm后，intellij將會在該方法的頭上為我自動生成注釋(根據我接下來定義的模板來生成)。
2.4、第四步點擊Define按鈕
點擊上圖中的Ok按鈕左上方的define
如圖：
在彈出的下拉框內選擇作用域，這里選擇java文件
如圖：
2.5、第五步填寫注釋模板
在第四步完成后，Templatetext框內的內容可以編輯了，在Template text 內寫入模板，例如我敲入的模板是：
/** *@描述 *@參數 $params$ *@返回值 $return$ *@創建人 chenjie *@創建時間 $date$ *@修改人和其它信息 */
如圖：
說明：在此步驟中，模板內容你可以自己寫，兩個$號內部是參數名稱，都有哪些參數呢，你可以點擊Editvariables，然后在彈窗口中自己查看和選擇
點擊Edit variables會彈出框
如圖：
彈出框
如圖：
上圖中，Name這一列是你可以設置的參數名稱，Expression這一列是你可以選擇的表達式，點擊Expression這一列的單元格，即可出現下拉框
如圖：
例如我依次給params、return、date這三個變量設置了表達式
如圖：
點擊OK(兩個窗口上的OK都要點擊)
好了，現在可以驗證了。
新建一個Utils類
如圖：
取名Utils
如圖：
可以看到，文件頭部的注釋已經有了
如圖：
新建一個方法，內容如下：
public static String sayHello(String userName)
{
return "hello "+userName;
}如圖：
在上圖畫紅框的地方輸入我們剛才設置的快捷鍵cmj即可看到intellij給我們添加的注釋
如圖：
快捷鍵需要在方法內部，也就是花括號內部，至于是不是在紅框的位置都可以，例如在return語句的后面或者其他地方也可以，只要是在sayHello方法內部即可。我輸入cjm然后就可以得到提示
如圖：
好了，敲回車后，intellij將我輸入的cjm替換為了方法的注釋(根據我們上一步設置的模板來生成注釋)
如圖：
說明：此時有點2，還需要自己把注釋剪切到方法外部去，不過總比我們手動敲注釋好多了?？旖萱I可以在方法外部敲，也可以生成注釋，但是參數和返回值就沒法給你生成了，因為參數和返回的值只有在函數作用域內，intellij才能找到，所以快捷鍵最好還是在方法內部敲，我剛才的cjm就是在方法內部敲的。
看完了這篇文章，相信你對“IDEA類和方法注釋模板設置的示例分析”有了一定的了解，如果想了解更多相關知識，歡迎關注億速云行業資訊頻道，感謝各位的閱讀！
免責聲明：本站發布的內容（圖片、視頻和文字）以原創、轉載和分享為主，文章觀點不代表本網站立場，如果涉及侵權請聯系站長郵箱：is@yisu.com進行舉報，并提供相關證據，一經查實，將立刻刪除涉嫌侵權內容。
