首页 > 其他分享 >IDEA类和方法注释模板设置(非常详细)

IDEA类和方法注释模板设置(非常详细)

时间:2023-03-09 19:33:50浏览次数:43  
标签:-- IDEA 注释 设置 方法 模板

类注释模板

  1. File-->settings-->Editor-->File and Code Templates-->Files
    我们选择Class文件(当然你要设置接口的还也可以选择Interface文件)
  • ${NAME}:设置类名,与下面的${NAME}一样才能获取到创建的类名
  • TODO:代办事项的标记,一般生成类或方法都需要添加描述
  • ${USER}、${DATE}、${TIME}:设置创建类的用户、创建的日期和时间,这些事IDEA内置的方法,还有一些其他的方法在绿色框标注的位置,比如你想添加项目名则可以使用${PROJECT_NAME}
  • 1.0:设置版本号,一般新创建的类都是1.0版本,这里写死就可以了
    image
  1. 效果图展示
    image

方法注释模板

  1. 创建模板
    IDEA还没有智能到自动为我们创建方法注释,这就是要我们手动为方法添加注释,
    /**+Enter这里我们也按照这种习惯来设置IDEA的方法注释
  • File-->Settings-->Editor-->Live Templates
    image
  • 新建组:命名为userDefine
    image
  • 新建模板:命名为*
    因为IDEA生成注释的默认方式是:/*+模板名+快捷键(比如若设置模板名为add快捷键用Tab,则生成方式为/*add+Tab),如果不采用这样的生成方式IDEA中没有内容的方法将不可用,例如获取方法参数的methodParameters()、获取方法返回值的methodReturnType()
    image
  • 设置生成注释的快捷键
    image
  1. 设置模板内容-IDEA格式模板
    注意第一行,只有一个*而不是/*
    在设置参数名时必须用${参数名}$的方式,否则第五步中读取不到你设置的参数名
*
 * @Author hjy
 * @Description //TODO $end$
 * @Date $time$ $date$
 * @Param $param$
 * @return $return$
 **/
*
 * 
 * @author hjy
 * @date $time$ $date$ $param$ $return$
 **/
  1. 设置模板应用场景
    点击模板页面最下方的警告,来设置将模板应用于那些场景,一般选择EveryWhere-->Java即可
    (如果曾经修改过,则显示为change而不是define)
    image
    image
  2. 设置参数
    选择右侧的Edit variables按钮
    注意:第3步和第4步顺序不可颠倒,否则第4步将获取不到方法
    image
  • IDEA格式的模板只需要为每个参数选择对应的方法即可
    image
  • JavaDoc格式的需要自定义参数以及返回值的实现方式
    获取参数实现方式:
groovyScript("def result = '';def params = \"${_1}\".replaceAll('[\\\\[|\\\\]|\\\\s]', '').split(',').toList(); for(i = 0; i < params.size(); i++) {if(params[i] != '')result+='* @param ' + params[i] + ((i < params.size() - 1) ? '\\r\\n ' : '')}; return result == '' ? null : '\\r\\n ' + result", methodParameters())

返回值实现方式:

groovyScript("return \"${_1}\" == 'void' ? null : '\\r\\n * @return ' + \"${_1}\"", methodReturnType())

设置的位置如下图:
image
5. 效果图
创建方法,在方法上面写:/*+模板名+Enter-->/**+Enter
IDEA格式的注释效果图:
image
JavaDoc格式的注释效果图:
image

标签:--,IDEA,注释,设置,方法,模板
From: https://www.cnblogs.com/yellow-mokey/p/17201143.html

相关文章

  • IDEA中web目录没有小蓝点的处理方法
    1.晚上启动一个练手项目时,发现网页报500错误,说路径错误,找不到\index.html页面,检查一番后发现,我的这个web项目的web目录没有被识别。也即没有小蓝点。2.打开项目结构,选择......
  • 【IDEA】无语问苍天的事件
    事件描述在一个项目上,一开始都是很正常地开发,运行然后呢,突然就冒出了一个问题,SLF4J:Failedtoloadclass"org.slf4j.impl.StaticLoggerBinder".SLF4J:Defaultingt......
  • .grf 读入报表模板失败,请检查网络连接、URL及读取权限,错误提示:网络服务器响应不成功
    http://xxx.xxx.xxx.xxx:xxx/Pages/QySqdInfo/../../GrfFile/Qianyue/qianyue_3303.grf从'http://xxx.xxx.xxx.xxx:xxx/Pages/QySqdInfo/../../GrfFile/Qianyue/qianyue_330......
  • C++ 三路快排 模板
    前言:今天被大作业的快速排序折磨的焦头烂额,原C++sort选手发现简洁的快排竟然如此难写(边界要注意的点好多qwq)。我原先的快排长这样:题解P1177【【模板】快速排序】......
  • IDEA 快捷键
    当前页面Ctrl+F搜索(必备)可以看常用快捷键!Ctrl快捷键 介绍Ctrl+F 在当前文件进行文本查找(必备)Ctrl+R 在当前文件进行文本替换(必备)Ctrl+Z 撤销(必备)Ctrl......
  • P3378 【模板】堆
    P3378【模板】堆【模板】堆题目描述给定一个数列,初始为空,请支持下面三种操作:给定一个整数x,请将x加入到数列中。输出数列中最小的数。删除数列中最小的数(如果有......
  • 学生身份激活IDEA2023.3月
    @[toc]前言这个方法其实一直存在,在IDEA的官网进行注册激活,按照如下流程就可以成功激活。必须有学生身份,不需要edu邮箱,去年我注册过一次,申请通过了,但是没有收到邮件,导致我一......
  • 设计模式(十七)----行为型模式之模板方法模式
    行为型模式用于描述程序在运行时复杂的流程控制,即描述多个类或对象之间怎样相互协作共同完成单个对象都无法单独完成的任务,它涉及算法与对象间职责的分配。行为型模式分为......
  • 上传数据、下载模板文件解决方案(前端:antd;后端:.Net Core WebAPI)
    上传数据、下载模板文件解决方案(前端:antd;后端:.NetCoreWebAPI) 阅读目录一、Excel模板下载二、上传Excel表格三、.NetCore3.0WebAPI文件接收与解析 ......
  • idea远程启动断点测试(jar)
    1.打开idea运行/调试配置2.选择添加--远程  3.输入linux服务ipxx,端口xx  4.登录linux服务器后台启动服务:java  -agentlib:jdwp=transport=dt_socket,......