一、前言
閱讀了阿裡巴巴java規範,裡面有一則重要的就是注釋規範,注釋寫好,猶如觀看美女。是以,下面介紹idea怎麼設定一鍵生成類注釋和方法注釋。
二、 類模闆注釋
操作步驟:
- File–>settings–>Editor–>File and Code Templates–>Files
- 選擇Class檔案(當然你要設定接口的還也可以選擇Interface檔案) ,添加注釋模闆如下:
#if (${PACKAGE_NAME} && ${PACKAGE_NAME} != "")package ${PACKAGE_NAME};#end
/**
*@Author: shen
*@CreateTime: ${YEAR}-${MONTH}-${DAY} ${HOUR}:${MINUTE}
*@Description: TODO
*@Version 1.0
*/
#parse("File Header.java")
public class ${NAME} {
}
二、方法模闆注釋
操作步驟:
- File–>Settings–>Editor–>Live Templates
- 建立組:命名為userDefine
- 建立模闆:命名為* , 因為IDEA生成注釋的預設方式是:/*+模闆名+快捷鍵 。
- 設定生成注釋的快捷鍵 :Enter
- 模闆内容-IDEA格式模闆
*
* @author: shen
* @date: $date$ $time$
* @description:
* @param: $param$
* @return: $return$
**/
- 選擇右側的Edit variables按鈕 , IDEA格式的模闆隻需要為每個參數選擇對應的方法即可
擷取參數:
傳回參數:
- 效果圖