idea注释模板设置

最新推荐文章于 2025-03-05 23:59:01 发布

ludkjava

最新推荐文章于 2025-03-05 23:59:01 发布

阅读量285

点赞数

文章标签： idea java

本文链接：https://blog.youkuaiyun.com/ludkjava/article/details/120809195

版权

  	开发过程中，需要按开发规范写详细的注释，便于读写代码。而idea自带的注释可能会与开发规范有出入，因此需要自定义配置注释模板。
	下面介绍了类注释、方法注释、行注释的注释模板配置。

类注释说明

打开：file->setting->Editor->Filr and Code Templates->Includes->File Header

    类注释模板：

/**  
    * @title: ${NAME}
    * @projectName ${PROJECT_NAME}
    * @description: TODO
    * @author ${USER}
    * @date ${DATE}${TIME}
    */

类注释模板图示
在这里插入图片描述

方法注释说明

file->setting->Editor->live Templates，点击“+”，选Template
Group，命名新的Template Group 为MyGroup。
选中MyGroup，点“+”新增live Template，快捷键为“*”，说明为方法注释。
填写Template text如下，注意开头没有“/”。

**
*@Description $description$
*@Param $params$
*@Return $returns$
*@Author ludengke
*@Date $date$
*@Time $time$
*/

Template text中定义了param、returns等变量。需要编辑变量的取值函数。
点击“defin”链接，然后选中everywhere，则该注释可以在任何地方使用

在这里插入图片描述

行注释说明

行注释与方法注释类似，模板信息如下：

// edit by ludengke at $date$ $time$ desc:TODO

配置信息如下：
在这里插入图片描述

使用方法及效果

类注释：新建类后，自动生成类注释，如下：

/**
 1. @author ludengke
 2. @title: TestMain
 3. @projectName springcloud-demo
 4. @description: TODO
 5. @date 2021/10/1712:57
 */

方法注释：输入 “/”+"*"+“tab”，生成方法注释，效果如下：

/**
    *@Description 
    *@Param [args]
    *@Return void
    *@Author ludengke
    *@Date 2021/10/17
    *@Time 14:00
    */
    public static void main(String[] args) {
        // edit by ludengke at 2021/10/17  desc://TODO
        boolean a=true;
        // edit by ludengke at 2021/10/17  desc://TODO
        if (a){
            // edit by ludengke at 2021/10/17  desc:TODO
            return;
        }
    }

行注释：输入“/”+“tab”，生成行注释，如下：

// edit by ludengke at 2021/10/17  desc:TODO