IDEA自定義生成註釋與作者版權信息

生成類註釋

1、打開Preferences

2、Editor -> File and Code Templates -> Files -> Class

在此添加的話你每次創建類的時候會彈兩次框,第二次是讓你輸入description的內容了

代碼如下

/**
 * ${description}
 *
 * @name: ${NAME}
 * @author: ${USER}
 * @date: ${YEAR}-${MONTH}-${DAY} ${HOUR}:${MINUTE}
 **/

接口(Interface)、枚舉(Enum)、註解(Annotation)的註釋同理。

生成效果

IDEA中其他類的查看效果

  • 備註:爲什麼不用下面的格式:因爲下面的格式在另一個類無法查看註釋。
/**
* @name: ${NAME}
* @description: ${description}
* @author: ${USER}
* @date: ${YEAR}-${MONTH}-${DAY} ${HOUR}:${MINUTE}
**/

生成方法註釋

打開Preferences

Editor -> Live Templates -> 點擊右邊加號爲自己添加一個Templates Group -> 然後選中自己的Group再次點擊加號添加Live Templates

新建模板:命名爲c

因爲IDEA生成註釋的默認方式是:/*+模板名+快捷鍵(比如若設置模板名爲c快捷鍵用Tab,則生成方式爲 /*c+Tab ),如果不採用這樣的生成方式IDEA中沒有內容的方法將不可用,例如獲取方法參數的methodParameters()、獲取方法返回值的methodReturnType()


 * @description: $description$
 * @param: $params$
 * @return: $returns$
 * @author: $user$
 * @date: $date$
 */
發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章