idea类注释、模板注释(方法注释)以及鼠标悬停显示注释

一、类注释

  1. File --> Settings --> Editor --> File and Code Templates --> Files。
    idea类注释、模板注释(方法注释)以及鼠标悬停显示注释_第1张图片
  2. 选择 Class、Interface 和 Enum,设置模板格式:
/**
 * @author     :weimo
 * @date       :Created in ${DATE}
 * @description:${description}
 */
  1. 勾选 Enable Live Templates 激活模板,点击 OK。
    idea类注释、模板注释(方法注释)以及鼠标悬停显示注释_第2张图片

二、方法注释

  1. File --> Settings --> Editor --> Live Templates。
  2. 选择添加 Templates Group,输入组名。
    idea类注释、模板注释(方法注释)以及鼠标悬停显示注释_第3张图片
  3. 选中 Group,选择添加 Live Template。
    idea类注释、模板注释(方法注释)以及鼠标悬停显示注释_第4张图片
  4. 设置默认快捷键为 Enter。
    idea类注释、模板注释(方法注释)以及鼠标悬停显示注释_第5张图片
  5. Abbreviation 填写 *,Template Text 填写以下代码:
*
 * 功能描述: 
 * @auther: weimo 
 * @date: $date$ $time$
$params$
 * @return $returns$
 */

idea类注释、模板注释(方法注释)以及鼠标悬停显示注释_第6张图片
这样在方法上输入 /* 按 Enter 键就可以触发此模板注释。
6. 点击 Edit variables 设置模板参数,Skip if… 是为了方便触发模板后跳出编辑模式。
idea类注释、模板注释(方法注释)以及鼠标悬停显示注释_第7张图片
值得一提的是关于 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 。
    idea类注释、模板注释(方法注释)以及鼠标悬停显示注释_第8张图片
  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。
    idea类注释、模板注释(方法注释)以及鼠标悬停显示注释_第9张图片
  3. 示例:
    idea类注释、模板注释(方法注释)以及鼠标悬停显示注释_第10张图片

你可能感兴趣的:(IntelliJ,IDEA,intellij,idea,java,注释,方法注释,类注释)