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 中创建新的类或方法时,注释将根据模板自动生成,并在生成注释时替换相应的占位符。

相关推荐
下一站春风里1 小时前
Spring IoC 控制反转 完整技术笔记
java·spring boot·笔记·spring
挖掘狂人1 小时前
用户连点两次「确认支付」,你的后端凭什么只扣一次钱?
java·后端·面试
codigger1 小时前
用户连点两次「确认支付」,你的后端凭什么只扣一次钱?
java·程序员·支付·java后端
Resean02231 小时前
SpringMVC 6+源码分析(十)数据绑定与类型转换
java·spring·springmvc
lw_zhang11011 小时前
爆肝一个月,Java 从入门到精通39 - 使用Log4j
java·单元测试·log4j
Rain的Java大神之路1 小时前
面试官问"MySQL 大表 COUNT(*) 怎么优化",90% 的人第一步就答错了
java·后端·面试
唐老板1 小时前
AI 都会编程了,Java 何去何从
java·ai编程
nice_lcj5201 小时前
MySQL 慢查询与 EXPLAIN:怎么定位、怎么优化
java·数据库·后端·mysql
芜名氏2 小时前
API 文档生成工具——SpringDoc
java·spring boot·ci/cd·设计规范
这个昵称不容易3 小时前
SpringBoot 医疗病历交互系统毕设:192 个 Java 文件、256 个接口、22 张表,附真实运行截图
java·springboot·毕设