Idea 格式设置

最新推荐文章于 2025-07-18 11:32:14 发布

原创最新推荐文章于 2025-07-18 11:32:14 发布 · 1k 阅读

0 ·

本内容遵循CC 4.0 BY-SA版权协议

收录于

后端

本文介绍了如何在 IntelliJ IDEA 中设置文件头和类注释模板，以及方法注释的Live Templates。通过菜单路径 File-Settings-Editor-File and Code Templates，用户可以定制代码模板，包括文件头、类注释和方法注释。同时，文章详细解释了预定义变量的使用，如 ${NAME}

类注释模板

菜单路径 File - Settings - Editor - File and Code Templates - Incudes - File Header 设置文件头注释

菜单路径 File - Settings - Editor - File and Code Templates - Files 设置类注释

部分预定义变量

预定义变量	描述信息
${NAME}	the name of the current file
${PACKAGE_NAME}	name of the package in which the new file is created
${USER}	current user system login name
${DATE}	current system date
${TIME}	current system time
${YEAR}	current year
${MONTH}	current month
${MONTH_NAME_SHORT}	first 3 letters of the current month name. Example: Jan, Feb, etc.
${MONTH_NAME_FULL}	full name of the current month. Example: January, February, etc.
${DAY}	current day of the month
${DAY_NAME_SHORT}	first 3 letters of the current day name. Example: Mon, Tue, etc.
${DAY_NAME_FULL}	full name of the current day. Example: Monday, Tuesday, etc.
${HOUR}	current hour
${MINUTE}	current minute
${PROJECT_NAME}	the name of the current project

方法注释模板

菜单路径 File - Settings - Editor - Live Templates

1. 添加 Template Group

2. 添加Live Template

3. 编辑方法注释格式

4. 点击Define，设置需要应用的场景

5. 点击 Edit variables，编辑定义的变量

其中template Text:

**
 * $method$
 * 
 $param$$return$ */

param的定义为：

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

return的定义为：

groovyScript("def result=''; def params=\"${_1}\"; if (\"void\" != params) {result += ' * @return ' + params + '\\n'}; return result", methodReturnType())

最终效果

在方法前输入 /** + tab

    /**
     * main
     *
     * @param args args
     */
    public static void main(String[] args) {
        System.out.println(args.length);
    }


    /**
     * test
     * 
     * @param args args
     * @return int
     */
    public static int test(String[] args) {
        return 0;
    }

标签

#idea #java