IDEA爲類和方法添加註釋

類註釋

•  註釋模板(也可以網上搜索更多模板)

/**
 * @author： your name
 * @version: 1.0
 * @date： $DATE$ $TIME$
 * @description： 
 */

新建一個類時，自動生成的類註釋配置

• 操作步驟如圖

 手動配置類註釋（已建好的類沒有註釋，爲其添加註釋）

• 操作步驟

1、如圖根據彈窗添加一個Group，隨意命名：如 MyClass

2、 找到剛剛新建的 MyClass 分組，跟隨步驟

3、 選擇添加 Live Templates 後進入如下界面，標號1處Abbreviation爲添加類註釋時的快捷方法，區別於默認的 /**+Enter ，標號2 爲解釋說明

4、加入註釋模板後，點擊標號4，彈出框如下，選擇配置即可

5、 如下圖所示，選擇change（若第一次此處爲Define）選中Java ，然後按上圖中的標號結束。

6、如圖 在類頭部輸入  /c  將會有提示，然後按下 Enter 鍵將添加默認的註釋

 

方法註釋

• 註釋模板(也可以網上搜索更多模板)

/**
 * @author: yourName
 * @description: 
$params$
 * @return: $return$
 * @time: $date$ $time$
 */

• 操作步驟

1、步驟與類註釋的添加步驟一樣，新進分組，添加Live Templates ，如圖加入註釋模板

 

2、點擊 標號4，進入彈窗配置參數

 

 

3、 其中 params 一欄將下面一段方法直接複製進去，其他項按圖選擇

 

groovyScript("def result=''; def params=\"${_1}\".replaceAll('[\\\\[|\\\\]|\\\\s]', '').split(',').toList(); for(i = 0; i < params.size(); i++) {result+=' * @param ' + params[i] + ((i < params.size() - 1) ? '\\n' : '')}; return result", methodParameters()) 

 

4、此步驟依然不能忘記

 

5、 添加完成後，即可進入類下的某一方法進行實現，在方法體內和方法體外輸入  /m+Enter，均可以完成添加註釋操作，但是在方法體外無法獲取參數的值