idea代碼注釋

轉載地址https://jingyan.baidu.com/article/19192ad8eb4134e53e5707a6.html

 轉載地址https://blog.csdn.net/xiaoliulang0324/article/details/79030752

裝載地址https://blog.csdn.net/sikefeng/article/details/80557265

網上找的好多說不明白這個說的比較明白，保存並分享，建議看點擊轉載地址查看原作者，原作者創作不易，請多多支持原創

 

在寫代碼時為了提高可閱讀性，我們經常需要給Java等語言的類及方法添加注釋，這時為了提高效率我們就可以用到注釋模板，本文將主要介紹如何用Intelij Idea配置類及方法的注釋模板提高代碼注釋效率。

工具/原料

 

• IntelliJ Idea 2017.1.5

一、准備工作

 

1. 1

   打開Idea，依次選擇【File】--> 【Settings】

   
2. 2

   在設置界面的搜索框中輸入live template查找到Live Templates配置項

   
3. 3

   點擊最右側的『+』號按鈕，添加一個模板組，這里組名我們填寫YC，這樣就完成了一個模板組的創建，接下來我們將在這個模板組下創建類注釋及方法注釋模板。

   

   
   END

二、配置類注釋模板

 

1. 1

   選中模板組YC，在最右側單擊『+』號按鈕，添加【Live Template】，輸入模板基礎信息（模板名稱填寫ccmt，模板介紹填寫類注釋模板），填寫完成后單擊第二張圖片箭頭指向處設置要針對的語言（這里我們只選擇了Java和JavaScript）。

   

   

   
2. 2

   在如下方框內輸入模板內容：

   /**

   * @Description:    java類作用描述

   * @Author:         yc

   * @CreateDate:     $DATE$ $TIME$

   * @UpdateUser:     yc

   * @UpdateDate:     $DATE$ $TIME$

   * @UpdateRemark:   修改內容

   * @Version:        1.0

   */

   注意：可以根據需要設置更多變量，在接下來的步驟中給設置的變量配置相應的取值函數。

   
3. 3

   單擊【Edit Variables】編輯變量，分別給上面的兩個變量Date、Time設置取值函數date(),time()，設置完成后單擊【OK】保存。

   

   
4. 4

   打開Java文件，在Java類上面輸入ccmt后按下回車鍵即可快速添加類注釋模板

   

   
   END

三、添加方法注釋模板

 

1.  

   參照【二、配置類注釋模板】，添加方法注釋模板，模板名稱為mcmt，模板內容為：

   /**

   * 方法實現說明

   * @author      作者姓名

   $param$

   * @return      $return$

   * @exception   $exception$

   * @date        $date$ $time$

   */

   
2.  

   點擊上圖的【Edit Variables】編輯變量，其中

   param中填寫Groovy腳本：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\\b' : '')}; return result", methodParameters())

   其他變量則從下拉框中直接選擇下圖對應的即可。

   
3.  

   完成上面的模板配置后，在如下方法上面輸入mcmt，然后按下Tab鍵或回車鍵就可以看到生成的方法注釋嘍！