• 一、設(shè)置類級(jí)別的注釋(創(chuàng)建類是自動(dòng)生成注釋)
• 二、設(shè)置方法級(jí)別的注釋

一、設(shè)置類級(jí)別的注釋(創(chuàng)建類是自動(dòng)生成注釋)

圖中的代碼塊:

/** * @author ${USER} * @date ${DATE} ${TIME} */ /** * @author sjl * @date ${YEAR}-${MONTH}-${DAY} ${HOUR}:${MINUTE} */

上述8個(gè)變量說(shuō)明:

$ {USER}：當(dāng)前系統(tǒng)登錄的用戶名，如果你的系統(tǒng)用戶名是windows默認(rèn)的Adminstrator，千萬(wàn)別用，鬼知道你 的同事里有多少人也是Administrator

${DATE}：當(dāng)前系統(tǒng)設(shè)置的日期格式，作為一個(gè)有強(qiáng)迫癥的程序員，不能接受同一項(xiàng)目的注釋里有超過(guò)一種的日期格式

${TIME}：當(dāng)前系統(tǒng)設(shè)置的時(shí)間格式，作為一個(gè)有強(qiáng)迫癥的程序員，不能接受同一項(xiàng)目的注釋里有超過(guò)一種的時(shí)間格式

${YEAR}：完整的年份，比如 2018

${MONTH}：完整的月份，比如 01

${DAY}：完整的日期，比如 17

${HOUR}：24小時(shí)制的小時(shí)，比如 16

${MINUTE}：完整的分鐘，比如 52

二、設(shè)置方法級(jí)別的注釋

如圖，創(chuàng)建一個(gè)新的group。

然后在添加模板。

編輯模板。

步驟說(shuō)明:

• 1是設(shè)置的快捷鍵，我這里設(shè)置的三個(gè)星號(hào)。

• 2是模板代碼塊

  ** * @description $description$ $params$ //也可以將此行改為 * @params $params$ * @return $return$ * @author SJl * @date $date$ $time$ * */ 注意這里的代碼塊前面是沒(méi)有/的，在方法外敲/+***+Enter就能生成注釋，如果你寫成/**開(kāi)頭的話在方法外敲是不能獲取return和params參數(shù)的，只有在方法內(nèi)敲才能獲取到。
• 3是選擇生效區(qū)域，點(diǎn)擊define，選擇everyWhere 或者 java。

• 4是參數(shù)設(shè)置。
  
  2的模板代碼塊如果你寫的是* @params $params$，參數(shù)設(shè)置請(qǐng)選擇 methodParameters()，如果你寫的是$params$，請(qǐng)粘貼以下代碼

  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())

• 5是選擇按鍵，默認(rèn)的是Tab，我一般選Enter。

兩種不同的顯示效果。

參考鏈接

轉(zhuǎn)載于:https://www.cnblogs.com/StoneGate/p/9378088.html

總結(jié)

以上是生活随笔為你收集整理的在idea中为类和方法自动生成注释的全部?jī)?nèi)容，希望文章能夠幫你解決所遇到的問(wèn)題。

如果覺(jué)得生活随笔網(wǎng)站內(nèi)容還不錯(cuò)，歡迎將生活随笔推薦給好友。