1. 程式人生 > 實用技巧 >idea 配置java class 方法註釋模板

idea 配置java class 方法註釋模板

idea 配置java class 方法註釋模板

路徑:Preferences -> Editor -> Live Templates

  1. 點選右上角的+號,然後選擇Template Group,輸入group的name,點ok。

  1. 輸入名稱,這裡起的名字是Java

  1. 選中剛剛建立的group Java,然後再次點選右側的+號,這次選擇的是第一個Live Template。

  1. 模板配置

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);
    }