點個贊，看一看，好習慣！本文 GitHub https://github.com/OUYANGSIHAI/JavaInterview 已收錄，這是我花了 3 個月總結的一線大廠 Java 面試總結，本人已拿大廠 offer。
另外，原創文章首發在我的個人博客：blog.ouyangsihai.cn，歡迎訪問。

IDEA自帶的注釋模板不是太好用，我本人到網上搜集了很多資料系統的整理了一下制作了一份比較完整的模板來分享給大家，我不是專業玩博客的，寫這篇文章只是為了讓大家省事。

這里設置的注釋模板采用Eclipse的格式，下面先貼出Eclipse的注釋模板，我們就按照這種格式來設置：

類注釋模板： 方法注釋模板：

一、首先我們來設置IDEA中類的模板：（IDEA中在創建類時會自動給添加注釋）

1、File–>settings–>Editor–>File and Code Templates–>Files

我們選擇Class文件（當然你要設置接口的還也可以選擇Interface文件）

（1）$NAME：設置類名，與下面的${NAME}一樣才能獲取到創建的類名

（2）TODO：代辦事項的標記，一般生成類或方法都需要添加描述

（3）$USER、${DATE}、$TIME：設置創建類的用戶、創建的日期和時間，這些事IDEA內置的方法，還有一些其他的方法在綠色框標注的位置，比如你想添加項目名則可以使用${PROJECT_NAME}

（4）1.0：設置版本號，一般新創建的類都是1.0版本，這里寫死就可以了

2、效果圖展示

二、設置方法注釋模板

IDEA還沒有智能到自動為我們創建方法注釋，這就是要我們手動為方法添加注釋，使用Eclipse時我們生成注釋的習慣是

/**+Enter，這里我們也按照這種習慣來設置IDEA的方法注釋

1、File–>Settings–>Editor–>Live Templates

（1）新建組：命名為userDefine
（2）新建模板：命名為*

因為IDEA生成注釋的默認方式是：/*+模板名+快捷鍵（比如若設置模板名為add快捷鍵用Tab，則生成方式為

/*add+Tab），如果不采用這樣的生成方式IDEA中沒有內容的方法將不可用，例如獲取方法參數的methodParameters(）、

獲取方法返回值的methodReturnType(）

（3）設置生成注釋的快捷鍵

（4）設置模板：模板內容如下

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

在設置參數名時必須用$參數名$的方式，否則第五步中讀取不到你設置的參數名

** @Author chengpunan* @Description //TODO $end$* @Date $time$ $date$* @Param $param$* @return $return$**/

如果使用/生成的模板注釋將會是如下效果：所以我們要去掉最前面的/

（5）設置模板的應用場景

點擊模板頁面最下方的警告，來設置將模板應用于那些場景，一般選擇EveryWhere–>Java即可

（如果曾經修改過，則顯示為change而不是define）
（6）設置參數的獲取方式

選擇右側的Edit variables按鈕

PS:第五步和第六步順序不可顛倒，否則第六步將獲取不到方法
選擇每個參數對應的獲取方法（在下拉選擇框中選擇即可），網上有很多教程說獲取param時使用腳本的方式，我試過使用腳本

的方式不僅麻煩而且只能在方法內部使用注釋時才能獲取到參數

（7）效果圖

創建方法，在方法上面寫：/*+模板名+Enter–>/**+Enter

出處：https://blog.csdn.net/xiaoliulang0324/article/details/79030752

最后，再分享我歷時三個月總結的 Java 面試 + Java 后端技術學習指南，這是本人這幾年及春招的總結，已經拿到了大廠 offer，整理成了一本電子書，拿去不謝，目錄如下：

現在免費分享大家，在下面我的公眾號 程序員的技術圈子 回復 面試 即可獲取。

有收獲？希望老鐵們來個三連擊，給更多的人看到這篇文章

1、老鐵們，關注我的原創微信公眾號「程序員的技術圈子」，專注于 Java、數據結構和算法、微服務、中間件等技術分享，保證你看完有所收獲。

2、給俺點個贊唄，可以讓更多的人看到這篇文章，順便激勵下我繼續寫作，嘻嘻。

3、另外，原創文章首發在我的個人博客：blog.ouyangsihai.cn，歡迎訪問。

點贊是對我最大的鼓勵
↓↓↓↓↓↓

總結

以上是生活随笔為你收集整理的IDEA类和方法注释模板设置（非常详细、实用）的全部內容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網站內容還不錯，歡迎將生活随笔推薦給好友。