IDEA类和方法注释模板设置(超详细教程1)

简介: IDEA类和方法注释模板设置(超详细教程)

一直在使用idea自带的注释模板,但是一直不太好用,最近在网上整理了一些比较完整的模板使用方法,来供大家学习使用,有不对的地方,欢迎大家在下方留言。

idea和eclipse的注释模板还是有一些差别的,下面就为大家介绍我整理的资料。

类注释模板:

/**
* @program: ${PROJECT_NAME}
* @ClassName ${NAME}
* @description: 
* @author: lyy
* @create: ${YEAR}-${MONTH}-${DAY} ${HOUR}:${MINUTE}
* @Version 1.0
**/
public class ${NAME} {
}


方法模板注释:

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


一、类注释

操作: File -> Settings - > Editor -> File and Code Templates -> Files -> Class

屏幕快照 2022-05-10 下午12.41.11.png

在右边的文件框里编辑需要注释的模板,应用保存之后,当我们创建类的时候就会自动生成注释。

类注释模板:

在右边的文件框里编辑需要注释的模板,应用保存之后,当我们创建类的时候就会自动生成注释。


类注释模板:


/**
* @program: ${PROJECT_NAME}
* @ClassName ${NAME}
* @description: 
* @author: lyy
* @create: ${YEAR}-${MONTH}-${DAY} ${HOUR}:${MINUTE}
* @Version 1.0
**/
public class ${NAME} {
}

1、如果要设置接口的,可以选择Interface文件

2、$ {PROJECT_NAME}:项目名,自动获取我们创建的项目名.

3、$ {NAME}:设置类名,与下面的$ {NAME}一样才能获取到创建的类名

4、TODO:代办事项的标记,一般生成类或方法都需要添加描述

5、$ {USER}:设置创建类的用户、创建的日期和时间,这些是IDEA内置的方法

6、$ {YEAR}-$ {MONTH}-$ {DAY} $ {HOUR} $ {MINUTE}:创建的日期和时间

7、@Version 1.0:设置版本号,一般新创建的类都是1.0版本


效果展示(当我们创建一个新类时,会自动添加注释):

屏幕快照 2022-05-10 下午12.41.50.png

目录
相关文章
|
3天前
|
Java
Idea自动生成注释
Idea自动生成注释
16 6
Idea自动生成注释
|
3月前
|
设计模式 数据可视化 Java
如何在 IDEA 中设置类路径
在 IntelliJ IDEA 中设置类路径,可以通过项目结构配置或模块设置来添加所需的库和依赖。具体步骤包括打开项目结构对话框、选择模块、添加类路径等。
558 18
|
4月前
|
Java
IDEA 利用groovy脚本生成注释
【10月更文挑战第29天】在 IntelliJ IDEA 中,可以通过创建和运行 Groovy 脚本来自动生成 Java 类方法的 Javadoc 注释。首先,创建一个 Groovy 文件并编写脚本,该脚本会检查每个方法是否已有注释,如果没有,则生成包含方法描述、参数列表和返回值的基本注释。接着,通过“Tools”菜单下的“Groovy Console”运行脚本,确保脚本中的包版本与当前使用的 IntelliJ IDEA 版本匹配。运行后,脚本将自动为选定类的方法添加注释。建议在执行前备份代码,以防意外。
145 2
|
4月前
|
SQL 存储 关系型数据库
MySQL 与 IntelliJ IDEA 同时兼容的注释
MySQL 与 IntelliJ IDEA 同时兼容的注释
84 2
|
4月前
|
Java
IDEA自定义配置注释模板,让你看起来更加专业!!!
IDEA自定义配置注释模板,让你看起来更加专业!!!
333 0
|
8月前
|
Java 编译器 Maven
使用intellij idea搭建SSM架构的maven项目 详细
使用intellij idea搭建SSM架构的maven项目 详细
123 4
|
7月前
|
IDE Oracle Java
day4:JDK、IntelliJ IDEA的安装和环境变量配置
【7月更文挑战第4天】🏆本文收录于「滚雪球学Java」专栏,专业攻坚指数级提升,希望能够助你一臂之力,帮你早日登顶实现财富自由🚀;同时,欢迎大家关注&&收藏&&订阅!持续更新中,up!up!up!!
267 0
|
7月前
|
网络协议 安全 Linux
在IntelliJ IDEA中使用固定公网地址远程SSH连接服务器环境进行开发
在IntelliJ IDEA中使用固定公网地址远程SSH连接服务器环境进行开发
164 2
|
8月前
|
Linux 开发工具 Windows
在WSL2中安装IntelliJ IDEA开发工具
在WSL2中安装IntelliJ IDEA开发工具
753 2
|
8月前
|
IDE Java Scala
IntelliJ IDEA 2023.3 最新变化2
IntelliJ IDEA 2023.3 最新变化
117 1

热门文章

最新文章