前言:
使用idea有過一段一段時間了,每次寫完方法需要都需要注釋,要么手動注釋要么用快捷鍵(/** 回車)默認模板注釋,不符合項目規定的注釋要求,於是想了想是不是設置自定義的注釋模板,上網查了資料整理一篇心得分享給大家。
正文:
默認注釋是的樣子:
/**
*
* @param bookType
* @param pageNum
* @param pageSize
* @return
*/
public PaginationEntity getBookByType(String bookType, int pageNum, int pageSize) {...}
我們注釋要求的樣子:
/**
* @Description: 根據圖書配型查詢圖書,工具類假分頁。參數:圖書類型,頁碼,每頁圖書數
* @Param: [bookType, pageNum, pageSize]
* @return: com.dmsdbj.library.controller.util.PaginationEntity
* @Author: 姜晶
* @Date: 2018/6/21
*/
public PaginationEntity getBookByType(String bookType, int pageNum, int pageSize) {...}
具體實現步驟:
1、打開系統設置Setting(Ctrl+Alt+S快捷鍵)
2、Editor—>Live Templates—>點擊+號。添加一個templates group來放置自己快捷鍵,效果圖如下:
3、選中創建的group—>再次點擊+號,添加一個Live template
4、設置自定義的快捷鍵模板:
Abbreviation:快捷鍵,Description:描述該快捷鍵
Template text:自定義的快捷鍵模板
**
* @Description: $description$
* @Param: $params$
* @return: $returns$
* @Author: 姜晶
* @Date: $date$
*/
效果圖:
類
/**
*
* @param bookType
* @param pageNum
* @param pageSize
* @return
*/
public PaginationEntity getBookByType(String bookType, int pageNum, int pageSize) {...}
方法
/**
* @Description: 根據圖書配型查詢圖書,工具類假分頁。參數:圖書類型,頁碼,每頁圖書數
* @Param: [bookType, pageNum, pageSize]
* @return: com.dmsdbj.library.controller.util.PaginationEntity
* @Author: 姜晶
* @Date: 2018/6/21
*/
public PaginationEntity getBookByType(String bookType, int pageNum, int pageSize) {...}
5、設置注釋的關聯變量:先設置好Template text內容后—>Edit variables,變量如效果圖設置就好。效果圖:
注意:注意:注意:設置完應用一下(Aplay)
應用的時候直接在方法前邊寫:/+快捷鍵名+Tab鍵。即可,比如我設置的快捷鍵方法名是a,效果圖便是:
結論:不將就是發現的源動力,在碰到繁瑣的事情面前,不是將它分解處理,就是要想一個方法簡化他。
————————————————
版權聲明:本文為CSDN博主「JackeyNNN」的原創文章,遵循CC 4.0 BY-SA版權協議,轉載請附上原文出處鏈接及本聲明。
原文鏈接:https://blog.csdn.net/jianghappyboy/article/details/80794552