IntelliJ IDEA 常用设置注释提示

Posted 2023-02-24 风清扬逍遥子

        每次新装Idea的时候都很操蛋的去网上百度这些代码上的注释怎么自动生成，为此我整理了下关于注释设置。

1、类的自定义注释

        新建一个类我们怎么保证类上自动生成注释？

        只需要进入Idea，点击Settings

        注释的内容我拷在这里了

/**
 * @Description: 
 * @Title: $NAME
 * @Author 你的名字
 * @Date: $DATE $TIME
 * @Version 1.0
 */

2、快捷键生成注释

        我们加注释可以不可以通过快捷键的方式做，当然可以；我们先建立一个模板的组

        Settings——》Live Templates——》Template Group

         我这里叫做my_template，然后在此基础上建立一个一个的Live Template

        分别建立名称为cls（Class的简写）和me（Method的简写），这三处分别要写上

         对于cls的注释

/**
 * @Description: 
 * @Title: $NAME$
 * @Author Star_Chen
 * @Date: $DATE$ $TIME$
 * @Version 1.0
 */

        对于me的注释，这要使用，直接方法上/me即可，因为如果/在这里面，就没法显示params和return。

**
 * @Date: $date$ $time$
 * @Description: 
$param$
 * @Return: $return$
 */

        在这两个template右侧有个编辑变量，其实就是注释里面这些$$包裹的

        对于cls我们对params输入：

groovyScript("if(\\"$_1\\".length() == 2) return ''; else def result=''; def params=\\"$_1\\".replaceAll('[\\\\\\\\[|\\\\\\\\]|\\\\\\\\s]', '').split(',').toList();for(i = 0; i < params.size(); i++) if(i<(params.size()-1))result+=' * @param ' + params[i] + ' : ' + '\\\\n'elseresult+=' * @param ' + params[i] + ' : '; return result;", methodParameters()); 

        对于return这么写：

groovyScript("def returnType = \\"$_1\\"; def result = ' * @return : ' + returnType; return result;", methodReturnType());

 

        对于me

        点击应用后，在代码的任何一处只要敲cls，或者me，回车就可以看到效果，我定义这两个是在类和方法上，属性上的大家可以自行配置，就不多说了。