IDEA类方法注释模板

最新推荐文章于 2024-08-20 10:58:18 发布

你去给我炒俩菜

最新推荐文章于 2024-08-20 10:58:18 发布

阅读量321

点赞数 10

文章标签： intellij-idea java ide

本文链接：https://blog.csdn.net/Blueeeeeeeeeeee/article/details/135958753

版权

idea添加类方法注释模板

（1）类、接口注释

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

复制下面模板到class和interface中（别忘记替换@author）

/**
* @projectName: ${PROJECT_NAME}
* @package:  ${PACKAGE_NAME}
* @ClassName: ${NAME}
* @author: liuxl
* @date: ${YEAR}/${MONTH}/${DAY} ${HOUR}:${MINUTE}
* @Version 1.0
**/
public class ${NAME} {
}

（2）方法注释

1、File -> Settings - > Editor -> Live Templates -> 点击"+"号 -> 选择 Template Group

2、新建组名，命名一个快捷方式缩写（Abbreviation）和一个描述（Description）

3、复制下面模板

/** 
 * @Description //TODO $end$
 * @Param $param$
 * @return $return$
 * @Author liuxl
 * @Date $time$ $date$
 **/

4、点击Define，选择java（全选），如果修改过，则显示为change而不是define

5、点击方法注释模板右边的Edit variables

下拉选择Expression参数
在这里插入图片描述

先写方法然后在方法内，输入"*"，按住tab注释就会自己出来了

方法内和方法外的区别

@RestController
@RequestMapping("/test")
public class asdaController {

    /** 
     * @Description //TODO 
     * @Param 
     * @return 
     * @Author liuxl
     * @Date 16:44 2024/1/31
     **/
    @GetMapping("/tttt")
    public BaseResult huhu(Long id,String name){
        /** 
         * @Description //TODO 
         * @Param [id, name]
         * @return result.BaseResult
         * @Author liuxl
         * @Date 16:44 2024/1/31
         **/
        return BaseResult.ok();
    }
}