IDEA 设置代码注释模板

news2025/1/20 19:20:36

功能简介:

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

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

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

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处:http://www.coloradmin.cn/o/1165543.html

如若内容造成侵权/违法违规/事实不符,请联系多彩编程网进行投诉反馈,一经查实,立即删除!

相关文章

《算法通关村—如何使用中序和后序来恢复一颗二叉树》

《算法通关村—如何使用中序和后序来恢复一颗二叉树》 中序:3 4 8 6 7 5 2 1 10 9 11 15 13 14 12 后序:8 7 6 5 4 3 2 10 15 14 13 12 11 9 1 通过后续遍历我们知道根节点是1,通过知道根节点是1,我们就可以从中序序列知道那些 …

不只保护隐私的防窥膜,还是屏幕的小铠甲

电脑防窥膜这种东西确实很实用,尤其是那些经常在公共场所用笔记本的朋友,更是需要这张贴膜的保护,不过虽然现在市面上这种防窥膜种类繁多,但是产品质量良莠不齐。有些防窥膜虽然有防窥效果,但透光率下降太多了&#xf…

【使用Python编写游戏辅助工具】第一篇:概述

引言 欢迎阅读本系列文章,本系列将带领读者朋友们使用Python来实现一个简单而有趣的游戏辅助工具。 写这个系列的缘由源自笔者玩了一款游戏。正巧,笔者对Python编程算是有一定的熟悉,且Python语言具备实现各种有趣功能的能力,因…

如何解决MySQL主从复制延时问题

MySQL 主从延时的原因是什么? 具体哪个环节发生延时? 如何解决呢? 对于这“三连问”,极少有同学能通关,甚至有同学连主从复制原理都不清楚。 01 什么是主从延时? 有时候我们遇到从数据库中获取不到信息…

Centos8安装yum源时候出现的异常问题及解决方案(保好使)

问题的出现 作者在使用centos8的时候,想安装tree命令,输入了如下的命令: yum install tree 但是却显示了下面的错误: Errors during downloading metadata for repository base: - Curl error (28): Timeout was reached for h…

MySQL第一讲·存储与字段

你好,我是安然无虞。 文章目录 1. 存储:一个完整的存储过程是怎样的?创建MySQL数据库确认字段创建数据表插入数据 2. 字段:那么多字段类型,该怎么定义?整数类型浮点数类型和定点数类型文本类型日期与时间类…

Shiny Server和ShinyProxy是什么,有什么区别?

调研以及参与过多个生物公司的生信工具研发,不管是ShinyServer还是ShinyProxy都有一定研究,尤其是ShinyServer。如果仅是本地化测试想快速的搭建Shiny应用,我推荐用Shiny Server,如果多并发用户且更好的线上管理Shiny应用&#xf…

【Unity数据交互】Json序列化你记得几分

ˊˊ 👨‍💻个人主页:元宇宙-秩沅 👨‍💻 hallo 欢迎 点赞👍 收藏⭐ 留言📝 加关注✅! 👨‍💻 本文由 秩沅 原创 👨‍💻 收录于专栏&#xff1…

掌握这几个技巧,才敢称为Jenkins大神!

01、Performance插件兼容性问题 自由风格项目中,有使用 Performance 插件收集构建产物,但是截至到目前最新版本(Jenkins v2.298,Performance:v3.19),此插件和Jenkins都存在有兼容性问题&#x…

scanpy赋值问题

今天发现一个很奇怪的bug import numpy as np import pandas as pd import anndata as ad from scipy.sparse import csr_matrix print(ad.__version__)counts csr_matrix(np.random.poisson(1, size(100, 2000)), dtypenp.float32) adata1 ad.AnnData(counts) print(adata1)…

基于深度学习的视频多目标跟踪实现 计算机竞赛

文章目录 1 前言2 先上成果3 多目标跟踪的两种方法3.1 方法13.2 方法2 4 Tracking By Detecting的跟踪过程4.1 存在的问题4.2 基于轨迹预测的跟踪方式 5 训练代码6 最后 1 前言 🔥 优质竞赛项目系列,今天要分享的是 基于深度学习的视频多目标跟踪实现 …

网络安全演练(一句话木马)

在享受互联网带来的便利的同时,也充满了各种网络安全风险,本文通过搭建实验环境,演示一句话木马获取主机权限。 演示环境 服务端:安装LAMP环境,部署web网站,上传一句话木马文件 客户端:安装A…

基于springboot实现在线考试平台项目【项目源码+论文说明】计算机毕业设计

基于springboot实现在线考试演示 摘要 网络的广泛应用给生活带来了十分的便利。所以把在线考试管理与现在网络相结合,利用java技术建设在线考试系统,实现在线考试的信息化。则对于进一步提高在线考试管理发展,丰富在线考试管理经验能起到不少…

【Linux】Nignx的入门使用负载均衡动静分离(前后端项目部署)---超详细

一,Nignx入门 1.1 Nignx是什么 Nginx是一个高性能的开源Web服务器和反向代理服务器。它使用事件驱动的异步框架,可同时处理大量请求,支持负载均衡、反向代理、HTTP缓存等常见Web服务场景。Nginx可以作为一个前端的Web服务器,也可…

【密评】商用密码应用安全性评估从业人员考核题库(十八)

商用密码应用安全性评估从业人员考核题库(十八) 国密局给的参考题库5000道只是基础题,后续更新完5000还会继续更其他高质量题库,持续学习,共同进步。 4251 判断题 对同一数据分别使用MD5和SHA1算法计算杂凑值&#xf…

centos7部署nginx

CentOS7安装Nginx-1.16.1稳定版 小白教程,一看就会,一做就成。 1.安装依赖环境 yum -y install gcc gcc-c automake pcre pcre-devel zlib zlib-devel openssl openssl-devel 2.下载安装包(不能联网的不行),可以留言…

Snagit 2024.0.1(mac截屏软件)

【捕获你的屏幕创意:Snagit 2024】 在视觉创意领域,你需要一款能够助你表达独特想法的工具,那就是Snagit 2024。这款软件将为你提供强大的图像处理和捕捉功能,帮助你实现你的创意构想。 Snagit 2024是一款功能强大的图像处理软件…

【npm run dev 报错:error:0308010C:digital envelope routines::unsupported】

问题原因: nodejs版本太高(nodejs v17版本发布了openSSL3.0对短发和密钥大小增加了更为严格的限制,nodejs v17之前版本没有影响,但之后的版本会出现这个错误,物品的node版本是20.9.0) 解决方式&#xff1…

测试老鸟,Python接口自动化测试框架搭建-全过程,看这篇就够了...

目录:导读 前言一、Python编程入门到精通二、接口自动化项目实战三、Web自动化项目实战四、App自动化项目实战五、一线大厂简历六、测试开发DevOps体系七、常用自动化测试工具八、JMeter性能测试九、总结(尾部小惊喜) 前言 1、接口测试自动化…

uniapp 省市区三级联动选择器

还有半个小时下班,总想着发点光亮照耀他人。IT技术这东西,尤其是UI方面的东西,于用户体验至关重要,想想最近使用uni-data-picker的丑陋页面,自己重构了这个功能,新加实现,效果图如下&#xff0c…