IDEA 设置代码注释模板

功能简介:

每次看别人代码时,面对毫无注释的类,除了头大还是头大,

以下提供了一种代码类注释模板

新建java类的时候,自动增加类注释,养成代码开发好习惯

效果展示:

代码模板:

复制代码
#if (${PACKAGE_NAME} && ${PACKAGE_NAME} != "")package ${PACKAGE_NAME};#end
#parse("File Header.java")

/**
 * @author ${USER}
 * @title TODO
 * @time ${DATE}
 */
public class ${NAME} {
}

/**
 * ${DESCRIPTION}
 *
 * This is a ${PURPOSE} that provides ${FUNCTIONALITY}.
 * It is designed to ${INTENDED_USE_CASE}.
 *
 * @author ${AUTHOR}
 * @since ${DATE}
 * @version ${VERSION}
 */

在上述注释模板中,您可以根据需要替换以下占位符:

  • ${DESCRIPTION}:简单描述类或方法的目的和功能。
  • ${PURPOSE}:说明代码的目的或用途。
  • ${FUNCTIONALITY}:指出代码提供的具体功能。
  • ${INTENDED_USE_CASE}:描述代码的预期使用场景。

此外,还有一些固定的占位符,无需手动替换:

  • ${AUTHOR}:自动生成为当前用户。
  • ${DATE}:自动生成为当前日期。
  • ${VERSION}:指定代码版本号(可以手动填写)。

设置代码注释模板的步骤如下:

  1. 打开 IntelliJ IDEA。
  2. 进入 "Preferences"(macOS)或 "Settings"(Windows/Linux)。
  3. 在设置窗口中,选择 "Editor" -> "File and Code Templates"。
  4. 在右侧的模板列表中,选择 "Includes" -> "File Header"。
  5. 在编辑器中,将上述代码注释模板复制并粘贴到现有模板中。
  6. 根据您的需求,修改注释模板并保存设置。

这样,当您在 IntelliJ IDEA 中创建新的类或方法时,注释将根据模板自动生成,并在生成注释时替换相应的占位符。

相关推荐
吃我一窝jio12 分钟前
Java博客极简写作三支柱
java
知识搬运临时工15 分钟前
双路服务器跑得比单路慢:JVM 没看见内存的距离
java·后端
吃我一窝jio1 小时前
Java Bug复盘与性能优化实战
java·开发语言·笔记
Flynn Liang1 小时前
Java 序列化也能成为瓶颈:Jackson、Protobuf 与 Redis 序列化的生产实践
java·redis·性能优化·jackson·序列化·protobuf
Yeats_Liao1 小时前
物联网平台优化系列(三):全局懒加载吞掉 MQTT 初始化
java·物联网·struts
千寻技术帮2 小时前
基于Spring Boot+Vue的农产品销售管理系统(源码+文档+数据库,附部署教程)
java·数据库·spring boot·后端·mysql·vue
好用斋2 小时前
拾光坞G2使用新版Docker懒人包:一键安装、一键升级、一键卸载
java·docker·容器
码云社区2 小时前
Spring Boot陪诊陪护系统源码:医院目录、服务项目与城市业务配置
java·spring boot·后端·陪诊陪护·医院陪诊·医院陪护·陪护小程序
CoderYanger4 小时前
Java EE 进阶:9.MyBatis 操作数据库(进阶)(第七弹):图书管理系统(强制登录)
java·数据库·spring boot·spring·java-ee·tomcat·mybatis
学长毕设4 小时前
基于SpringBoot 餐饮餐厅点菜管理系统-附源码
java·spring boot·后端