IDEA类、方法注释模板配置

最新推荐文章于 2024-10-07 22:07:14 发布

原创最新推荐文章于 2024-10-07 22:07:14 发布 · 244 阅读

0 ·

CC 4.0 BY-SA版权

文章标签：

#intellij idea

Intellij Idea 专栏收录该内容

2 篇文章

订阅专栏

本文介绍如何在IntelliJ IDEA中配置类、接口及方法的注释模板，包括作者、日期等元数据的自动填充，提升开发效率。

类注释配置

File ---> Settings ---> Editor ---> File and Code Templates ---> Files ---> Class

/**
 * TODO
 *
 * @author KevinChen
 * @date ${DATE} ${TIME}
*/   
public class ${NAME} {
    
}

例

/** 
 * 类注释描述
 *
 * @author admin
 * @date 2020/1/1 12:00
 */

接口注释配置

File ---> Settings ---> Editor ---> File and Code Templates ---> Files ---> Interface

/**
 * TODO
 * 
 * @author KevinChen
 * @Date ${DATE} ${TIME}
 */ 
public interface ${NAME} {

}

例

/** 
 * 接口注释描述
 *
 * @author admin
 * @date 2020/1/1 12:00
 */

方法注释配置

创建Live Templates分组：File ---> Settings ---> Editor ---> Live Templates ---> 点击右上角 + 号 ---> Template Group

创建模板(Template)

设置模板内容

模板缩写（Abbreviation）。例：上述设置为 " * "
模板描述（Description）。例：上述设置为 "方法注释"

模板内容：

* 
 * TODO 
 *      
 * @author KevinChen
 * @date $date$ $time$ 
$param$
 * @return $return$       
 */

定义模板内容中引用的变量

return：methodReturnType()
date：date()
time：time()

params：

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())

定义模板使用范围：勾选Java栏

效果