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

相关推荐
一个天蝎座 白勺 程序猿31 分钟前
飞算JavaAI进阶:重塑Java开发范式的AI革命
java·开发语言·人工智能
前端 贾公子34 分钟前
tailwindCSS === 使用插件自动类名排序
java·开发语言
没有bug.的程序员40 分钟前
JAVA面试宝典 -《Spring Boot 自动配置魔法解密》
java·spring boot·面试
hnlucky1 小时前
《Nginx + 双Tomcat实战:域名解析、静态服务与反向代理、负载均衡全指南》
java·linux·服务器·前端·nginx·tomcat·web
hnlucky1 小时前
同时部署两个不同版本的tomcat要如何配置环境变量
java·服务器·http·tomcat·web
yngsqq2 小时前
netdxf—— CAD c#二次开发之(netDxf 处理 DXF 文件)
java·前端·c#
A了LONE2 小时前
h5的底部导航栏模板
java·前端·javascript
专注VB编程开发20年2 小时前
各版本操作系统对.NET支持情况(250707更新)
开发语言·前端·ide·vscode·.net
经典19923 小时前
spring boot 详解以及原理
java·spring boot·后端
星光54223 小时前
飞算JavaAI:给Java开发装上“智能引擎”的超级助手
java·开发语言