IDEA的类注释模板

简介: IDEA的类注释模板

类注释模板

首先IDEA的配置路径为:File>Settings>File>Editor>File and Code Templates>Files


可以依次在Class、Interface、Enum、AnnotationType各项的右侧添加注释模板


注释模板为


/**


@className : ${NAME}

@description : [描述说明该类的功能]

@author : [LiuYanQiang]

@version : [v1.0]

@createTime : [${DATE} ${TIME}]

@updateUser : [LiuYanQiang]

@updateTime : [${DATE} ${TIME}]

@updateRemark : [描述说明本次修改内容]

*/

效果展示为

方法注释模板

首先IDEA的配置路径为:File>Settings>File>Editor>Live Templates


1.新建Template Group:MethodTemplate (名称自定义)


2.点击模板组MethodTemplate,然后在最上方By default expand with处选择enter来设置使用注释模板的快捷方式,然后在模板组MethodTemplate下添加Live Template


3.Abbreviation添加为 * ,Description添加为 add Comments for method(此项为添加方法的描述,写不写都行)


4.Template text添加的注释代码:


@version V1.0

Title: N A M E NAMENAME

@author LiuYanQiang

@description 描述说明该方法的功能

@createTime d a t e datedate t i m e timetime

@param p a r a m paramparam

@return r e t u r n returnreturn

注意:如若下面出现No applicable contexts yet. Define的警告则需要设置Everywhere目录下的Java选项,此选项是设置模板的应用场景的(如果以前修改过那出现的就是change)

5.点击Edit variables选项配置参数:


最后在方法名上面用键盘按下CTRL+Shift+/,方法注释就出来了,效果图如下


相关文章
|
9月前
|
Java
Idea自动生成注释
Idea自动生成注释
311 6
Idea自动生成注释
|
9月前
|
人工智能 自然语言处理 Java
IDEA + 通义灵码 AI 程序员:快速构建 DDD 后端工程模板
本文介绍了如何利用 IntelliJ IDEA 编辑器和阿里云的通义灵码 AI 程序员,快速搭建一个基于 DDD 领域驱动架构的后端工程模板。
|
设计模式 数据可视化 Java
如何在 IDEA 中设置类路径
在 IntelliJ IDEA 中设置类路径,可以通过项目结构配置或模块设置来添加所需的库和依赖。具体步骤包括打开项目结构对话框、选择模块、添加类路径等。
2002 18
|
搜索推荐 Java 数据库连接
Java|在 IDEA 里自动生成 MyBatis 模板代码
基于 MyBatis 开发的项目,新增数据库表以后,总是需要编写对应的 Entity、Mapper 和 Service 等等 Class 的代码,这些都是重复的工作,我们可以想一些办法来自动生成这些代码。
309 6
IDEA 利用groovy脚本生成注释
【10月更文挑战第29天】在 IntelliJ IDEA 中,可以通过创建和运行 Groovy 脚本来自动生成 Java 类方法的 Javadoc 注释。首先,创建一个 Groovy 文件并编写脚本,该脚本会检查每个方法是否已有注释,如果没有,则生成包含方法描述、参数列表和返回值的基本注释。接着,通过“Tools”菜单下的“Groovy Console”运行脚本,确保脚本中的包版本与当前使用的 IntelliJ IDEA 版本匹配。运行后,脚本将自动为选定类的方法添加注释。建议在执行前备份代码,以防意外。
444 2
|
SQL 存储 关系型数据库
MySQL 与 IntelliJ IDEA 同时兼容的注释
MySQL 与 IntelliJ IDEA 同时兼容的注释
251 2
|
人工智能 Java 数据库连接
IDEA开发 常用代码规范插件 常用辅助类插件
IDEA开发 常用代码规范插件 常用辅助类插件
1580 1
IDEA自定义配置注释模板,让你看起来更加专业!!!
IDEA自定义配置注释模板,让你看起来更加专业!!!
1436 0
Java系列之 IDEA 为类 和 方法设置注解模板
这篇文章介绍了如何在IntelliJ IDEA中为类和方法设置注解模板,包括类模板的创建和应用,以及两种不同的方法注解模板的创建过程和实际效果展示,旨在提高代码的可读性和维护性。