一.文件注釋

創(chuàng)建文件后, 編譯器會在類名前面生成固定的注釋, 來豐富代碼的可讀性, 在阿里巴巴Java開發(fā)手冊里也明確寫到所有的類都必須添加創(chuàng)建者和創(chuàng)建日期.

image

/**
 * description: ${NAME} <br>
 * date: ${DATE} ${TIME} <br>
 * author: ${USER} <br>
 * version: 1.0 <br>
 */

我們來看一下效果吧

image

其中以$開頭的都是IDE中的內(nèi)置變量, 我們把它引用過來, 也可以自定義成常量.

二.方法注釋

寫方法的時候也要帶上相應(yīng)的注釋, 這樣可以增加方法的可讀性, 下面我們就來添加一個自定義注釋模板, 方法注釋的配置要比文件注釋復(fù)雜一些

1.創(chuàng)建一個group名字隨便起

image

2.選中g(shù)roup并新建一個模板

image

3.選擇模板類型

image

勾選java

image

4.填寫模板內(nèi)容

image

*
 * description: $description$ <br>
 * version: 1.0 <br>
 * date: $date$ $time$ <br>
 * author: objcat <br>
$params$
 * @return $return$
 */ 

注意上述文字一定要一個字不差的填寫, 我的模板并沒有寫歪, 而是必須要這么寫才能正常使用, 關(guān)鍵字需要用*, 不要改動.

添加快捷鍵與注釋

Abbreviation 關(guān)鍵字
Description 模板說明

5.關(guān)聯(lián)變量

點(diǎn)擊關(guān)聯(lián)按鈕

image

按照圖中的方式去關(guān)聯(lián)變量

image

變量不用手打, 可以下拉選擇

image

注意第三個參數(shù)是一個groovy腳本目的是把參數(shù)羅列出來

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

這里說一下為什么要關(guān)聯(lián)變量 你應(yīng)該可以發(fā)現(xiàn)在模板中有
$date$ $time$ $params$ $return$ 這些用$符號包括的代碼 這些都是自定義變量, 而我想在寫注釋的時候?qū)崟r獲取這些, 比如時間, 日期, 參數(shù)名, 返回值類型 所以需要關(guān)聯(lián)編譯器的變量自動填入.

到了這一步 設(shè)置都結(jié)束了

使用方法 只需要打 /** + tab 就可以了

好的我們來看一看效果吧

image

我們來生成一個javadoc看看效果
Tools -> Generate JavaDoc

image

如果出現(xiàn)編碼問題請如圖填入下面這句話(屏幕一大堆問號)

-charset utf-8 -encoding utf-8

image

image

finally enjoy it

作者：objcat
鏈接：http://www.itdecent.cn/p/812d06702437
來源：簡書
簡書著作權(quán)歸作者所有，任何形式的轉(zhuǎn)載都請聯(lián)系作者獲得授權(quán)并注明出處。