idea 配置java class 方法注释模板

idea 配置java class 方法注释模板

路径：Preferences -> Editor -> Live Templates

1. 点击右上角的+号，然后选择Template Group，输入group的name，点ok。

2. 输入名称，这里起的名字是Java

3. 选中刚刚创建的group Java，然后再次点击右侧的+号，这次选择的是第一个Live Template。

4. 模板配置

Abbreviation写**

Template text 写（注意是**开头，不是/**开头）

**
 * @description:
 * @author: $user$
 * @date: $date$$params$
 * @return: $return$
 */

此处 Expend With 配置为 Enter 回车键，注释生成快捷方式，看个人习惯，也可以时 Tab 键。

编辑好模板之后就为参数添加变量，点击右侧的 Editor variables配置变量

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

若有警告信息 No Applicable contexts，点击 Define 选中 Java 即可。

点击 Apply OK 应用配置即可。效果如下（分别为无参方法和有参方法）

    /**
     * @description:
     * @author: dingzg
     * @date: 8/14/20
     * @return: org.springframework.batch.core.Step
     */
    @Bean
    public Step testStep(){
        return stepBuilderFactory.get("testStep").tasklet(new Tasklet() {
            @Override
            public RepeatStatus execute(StepContribution stepContribution, ChunkContext chunkContext) throws Exception {
                return RepeatStatus.FINISHED;
            }
        }).build();
    }

    /**
     * @description:
     * @author: dingzg
     * @date: 8/14/20
     * @param: args
     * @return: void
     */
    public static void main(String[] args) {
        SpringApplication.run(BatchProjectApplication.class, args);
    }