idea類註釋、模板註釋(方法註釋)以及鼠標懸停顯示註釋

一、類註釋

  1. File --> Settings --> Editor --> File and Code Templates --> Files。
    在這裏插入圖片描述
  2. 選擇 Class、Interface 和 Enum,設置模板格式:
/**
 * @author     :weimo
 * @date       :Created in ${DATE}
 * @description:${description}
 */
  1. 勾選 Enable Live Templates 激活模板,點擊 OK。
    在這裏插入圖片描述

二、方法註釋

  1. File --> Settings --> Editor --> Live Templates。
  2. 選擇添加 Templates Group,輸入組名。
    在這裏插入圖片描述
  3. 選中 Group,選擇添加 Live Template。
    在這裏插入圖片描述
  4. 設置默認快捷鍵爲 Enter。
    在這裏插入圖片描述
  5. Abbreviation 填寫 *,Template Text 填寫以下代碼:
*
 * 功能描述: 
 * @auther: weimo 
 * @date: $date$ $time$
$params$
 * @return $returns$
 */

在這裏插入圖片描述
這樣在方法上輸入 /* 按 Enter 鍵就可以觸發此模板註釋。
6. 點擊 Edit variables 設置模板參數,Skip if… 是爲了方便觸發模板後跳出編輯模式。
在這裏插入圖片描述
值得一提的是關於 params 的形式,如果選擇自帶表達式 methodParameters() 生成的模板是不會換行的,這裏提供以下代碼:

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' : '')}; return result", methodParameters()) 
  1. 點擊下方小字 Change 設置生效範圍,勾選 Java,點擊 OK 。
    在這裏插入圖片描述
  2. 模板示例:
/**
 * 功能描述:
 * @auther: weimo
 * @date: 2020/4/13 18:13
 * @param id
 * @param decode
 * @return com.alibaba.fastjson.JSONObject
 */
JSONObject demo(String id, Decode decode);

三、鼠標懸停顯示註釋

  1. File --> Settings --> Editor --> General
  2. other 欄勾選 Show quick …,點擊 OK。
    在這裏插入圖片描述
  3. 示例:
    在這裏插入圖片描述
發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章