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

目录
相关文章
|
7月前
|
IDE 程序员 开发工具
只用正版!教你5个方法,白嫖JetBrains家族的所有产品,包含:IntelliJ IDEA、PyCharm、WebStorm、CLion、Rider
程序员晚枫分享了5种官方认证的免费使用JetBrains家族产品的方法,包括内容创作者计划、开源项目支持、教育许可证、用户组支持和开发者认可计划。这些方法帮助个人开发者与小型团队合法获取强大开发工具,如IntelliJ IDEA、PyCharm等,降低开发成本,提升效率。同时提醒大家遵守使用规范,尊重知识产权。
1129 13
|
8月前
|
人工智能 自然语言处理 Java
IDEA + 通义灵码 AI 程序员:快速构建 DDD 后端工程模板
本文介绍了如何利用 IntelliJ IDEA 编辑器和阿里云的通义灵码 AI 程序员,快速搭建一个基于 DDD 领域驱动架构的后端工程模板。
|
11月前
|
设计模式 数据可视化 Java
如何在 IDEA 中设置类路径
在 IntelliJ IDEA 中设置类路径,可以通过项目结构配置或模块设置来添加所需的库和依赖。具体步骤包括打开项目结构对话框、选择模块、添加类路径等。
1853 18
|
12月前
|
存储 缓存 Java
java基础:IO流 理论与代码示例(详解、idea设置统一utf-8编码问题)
这篇文章详细介绍了Java中的IO流,包括字符与字节的概念、编码格式、File类的使用、IO流的分类和原理,以及通过代码示例展示了各种流的应用,如节点流、处理流、缓存流、转换流、对象流和随机访问文件流。同时,还探讨了IDEA中设置项目编码格式的方法,以及如何处理序列化和反序列化问题。
302 1
java基础:IO流 理论与代码示例(详解、idea设置统一utf-8编码问题)
|
11月前
|
Java Windows
IDEA不使用lombok,如何快速生成get和set方法
【11月更文挑战第10天】在 IntelliJ IDEA 中生成 `get` 和 `set` 方法有多种方式:通过菜单操作、使用快捷键或自定义模板。菜单操作包括选择“Code”菜单中的“Generate...”,快捷键为“Alt + Insert”。自定义模板可在“File”->“Settings”->“Editor”->“Code Style”->“Java”中设置。批量生成时,可多选变量一次性生成。
2084 2
|
12月前
|
搜索推荐 Java 数据库连接
Java|在 IDEA 里自动生成 MyBatis 模板代码
基于 MyBatis 开发的项目,新增数据库表以后,总是需要编写对应的 Entity、Mapper 和 Service 等等 Class 的代码,这些都是重复的工作,我们可以想一些办法来自动生成这些代码。
234 6
|
12月前
|
Linux Android开发 Windows
IDEA如何设置成Eclipse的快捷键
【10月更文挑战第9天】这段内容介绍了如何在 IntelliJ IDEA 中设置类似 Eclipse 的快捷键。主要包括:1) 打开设置;2) 进入快捷键设置页面;3) 选择 Eclipse 快捷键方案;4) 可选的自定义调整。通过这些步骤,可以让熟悉 Eclipse 的用户更快适应 IDEA。
2695 4
|
12月前
|
Java
IDEA自定义配置注释模板,让你看起来更加专业!!!
IDEA自定义配置注释模板,让你看起来更加专业!!!
1239 0
|
Java Android开发
Idea使用系列之一:Idea设置类注释模板和方法注释模板
现在Idea越来越流行了,自己慢慢开始从Eclipse转向Idea开发。刚开始使用Idea,肯定会遇到各种各样的设置问题,所以在博客上专门有个文章系列进行记录,希望给转Idea开发的同学一点帮助。 设置类模板 设置方法模板
Idea使用系列之一:Idea设置类注释模板和方法注释模板