【idea】idea设置类注释和方法注释

本文章基于window idea2019.3版本撰写。

（一）类注释模板设置

//类注释设置模板
/**
 
 *
 
 * @author yuhua
 
 * @date $date$
 
 */ 

第一步，打开模板设置窗口，windows idea选项file->setting->liveTemplates->+ ->选择2template...  mac系统在preference选项下。

随着idea的版本更新可能对应的选项位置发生变化，设置时搜索就可以。先创建一个模板组。

第二步： 将光标选中刚建好的Group，idea选项file->liveTemplates->+ ->选择1 live... mac在Preference->live...

第三步：设置快捷方式，添加模板内容。 

第四步：设置变量值。 

 

以上就是对于类注释模板的设置。

（二）方法的设置，与类注释模板设置步骤一样，这儿使用多参设置（建议入参大于3个采用实体类的形式）。

//方法注释模板设置
/**
 * 
 $param$
 * @return $return$
 * @author yuhua
 * @date $date$
 */

方法基本设置图:

变量配置图：方法变量配置与类变量配置最大的不同在于param参数配置，为了应对多个入参的情况采用脚本的形式产生。

param参数脚本：

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

 

由于作者本人使用了阿里编程规约插件，类与方法模板设置均为了支持规约，大家没有必要跟我的一模一样，根据自己需求设置就可以。

（三）最终效果

/**
 * 接口中方法注释
 *
 * @author yuhua
 * @date 2020/4/29
 */
public interface TemplateSettingInterface {

    /**
     * 接口中注释没法进入到接口方法内部使用生成快捷键，@param参数是空，我们必须手动假如param参数
     * 阿里编程规约中要求写接口方法注释
     * @param test1 1
     * @param test2 1
     * @return String
     * @author yuhua
     * @date 2020/4/29
     */
    String templateSettingInterface(String test1, String test2);
}


/**
 * 普通类中注释模板
 *
 * @author yuhua
 * @date 2020/4/29
 */
public class TemplateSettingClass {
    /**
     * 在方法外使用快捷键会取不到param与return
     * 注意在方法内外使用快捷键的区别
     * @param null 1
     * @return
     * @author yuhua
     * @date 2020/4/29
     */
    public String templateSettingClass(String test1, String test2) {
        /**
         * 要想获取到参数当前需要在类方法里面使用快捷键
         * 阿里巴巴编程规约中没有规定普通类中必须写方法注释
         * @param test1 1
         * @param test2 2
         * @return java.lang.String
         * @author yuhua
         * @date 2020/4/29
         */

        return test1 + test2;
    }
    
}

 

图中的快捷键可以根据自己习惯设置，也没必要跟本文一模一样。通过这种方式，还可创建更多便捷的其他类型的模板。