idea 模版之自定義類(lèi)與方法注釋

很多公司都有要求的代碼注釋規(guī)范，我們每新建類(lèi)或者方法的時(shí)候從新復(fù)制粘貼很麻煩，而且容易粘錯(cuò)。

當(dāng)然自定義模板還可以用到很多地方，比如系統(tǒng)自帶的 sout就是system.out.print(); 當(dāng)你輸入某文本的時(shí)候，系統(tǒng)會(huì)自動(dòng)替換成目標(biāo)文本。

1定義java文件頭部的注釋

2給java類(lèi)中的方法添加上注釋

      2.1第一步勾選Enable Live  Templates

      2.2第二步新建一個(gè)Group

      2.3第三步新建一個(gè)Template

      2.4第四步點(diǎn)擊Define按鈕

      2.5第五步填寫(xiě)注釋模板

1、定義java文件頭部的注釋

打開(kāi)設(shè)置面板，然后填寫(xiě)注釋模板：

File  => setting  => editor =>  File and Code Templates

如圖：

2、給java類(lèi)中的方法添加上注釋

2.1、第一步勾選Enable  Live  Templates

首先要在上一章節(jié)的圖中勾選中 Enable  Live  Templates

如圖：

2.2、第二步新建一個(gè)Group

其次要打開(kāi)LiveTemplates 然后新建一個(gè)Group

如圖：

在彈窗口中輸入你想要的group名稱(chēng)，例如我取名叫chenjieGroup

如圖：

點(diǎn)擊OK，你已經(jīng)新建了一個(gè)模板組，名稱(chēng)叫chenjieGroup

如圖：

2.3、第三步新建一個(gè)Template

選中新建的group，也就是選中chenjieGroup，在這個(gè)group下新建一個(gè)LiveTemplate

如圖：

上圖中點(diǎn)擊Live Template之后，將會(huì)新建一個(gè)模板，并且光標(biāo)定位到了需要你輸入快捷鍵的方框中

如圖：

我輸入了cjm意思是當(dāng)我在java文件的某個(gè)方法內(nèi)部，連續(xù)輸入cjm后，intellij將會(huì)在該方法的頭上為我自動(dòng)生成注釋(根據(jù)我接下來(lái)定義的模板來(lái)生成)。

2.4、第四步點(diǎn)擊Define按鈕

點(diǎn)擊上圖中的Ok按鈕左上方的define

如圖：

在彈出的下拉框內(nèi)選擇作用域，這里選擇java文件

如圖：

2.5、第五步填寫(xiě)注釋模板

 在第四步完成后，Templatetext框內(nèi)的內(nèi)容可以編輯了，在Template text 內(nèi)寫(xiě)入模板，例如我敲入的模板是：

/**

 *@描述 

 *@參數(shù) $params$

 *@返回值 $return$

 *@創(chuàng)建人 chenjie

 *@創(chuàng)建時(shí)間 $date$

 *@修改人和其它信息

 */

如圖：

說(shuō)明：在此步驟中，模板內(nèi)容你可以自己寫(xiě)，兩個(gè)$號(hào)內(nèi)部是參數(shù)名稱(chēng)，都有哪些參數(shù)呢，你可以點(diǎn)擊Editvariables，然后在彈窗口中自己查看和選擇

點(diǎn)擊Edit variables會(huì)彈出框

如圖：

彈出框

如圖：

上圖中，Name這一列是你可以設(shè)置的參數(shù)名稱(chēng)，Expression這一列是你可以選擇的表達(dá)式，點(diǎn)擊Expression這一列的單元格，即可出現(xiàn)下拉框

如圖：

例如我依次給params、return、date這三個(gè)變量設(shè)置了表達(dá)式

如圖：

點(diǎn)擊OK(兩個(gè)窗口上的OK都要點(diǎn)擊) 

好了，現(xiàn)在可以驗(yàn)證了。

新建一個(gè)Utils類(lèi)

如圖：

取名Utils

如圖：

可以看到，文件頭部的注釋已經(jīng)有了

如圖：

新建一個(gè)方法，內(nèi)容如下：

 public static String sayHello(String userName)
{
   return "hello "+userName; 
}

如圖：

在上圖畫(huà)紅框的地方輸入我們剛才設(shè)置的快捷鍵cmj即可看到intellij給我們添加的注釋

如圖：

快捷鍵需要在方法內(nèi)部，也就是花括號(hào)內(nèi)部，至于是不是在紅框的位置都可以，例如在return語(yǔ)句的后面或者其他地方也可以，只要是在sayHello方法內(nèi)部即可。我輸入cjm然后就可以得到提示

如圖：

好了，敲回車(chē)后，intellij將我輸入的cjm替換為了方法的注釋(根據(jù)我們上一步設(shè)置的模板來(lái)生成注釋)

 如圖：

說(shuō)明：此時(shí)有點(diǎn)2，還需要自己把注釋剪切到方法外部去，不過(guò)總比我們手動(dòng)敲注釋好多了?？旖萱I可以在方法外部敲，也可以生成注釋?zhuān)菂?shù)和返回值就沒(méi)法給你生成了，因?yàn)閰?shù)和返回的值只有在函數(shù)作用域內(nèi)，intellij才能找到，所以快捷鍵最好還是在方法內(nèi)部敲，我剛才的cjm就是在方法內(nèi)部敲的。

以上就是本文的全部?jī)?nèi)容，希望對(duì)大家的學(xué)習(xí)有所幫助，也希望大家多多支持腳本之家。

最新評(píng)論