idea 中配置 Java 注释模板

news2024/12/23 10:57:21

引言:

在软件工程中,良好的代码注释习惯对于项目的可维护性和可读性至关重要。IntelliJ IDEA,作为一款强大的Java开发IDE,提供了灵活的注释模板配置功能,帮助开发者快速生成规范的代码注释。本文将详细介绍如何在IntelliJ IDEA中配置Java类的注释模板和方法注释模板,以提升编码效率和代码质量。

一、类注释模板

操作: File -> Settings - > Editor -> File and Code Templates -> Files -> Class或Inferface

在这里插入图片描述

类注释模板文件:

/**
* @program: ${PROJECT_NAME}
* @ClassName ${NAME}
* @description: 
* @author: dazhong2012
* @create: ${YEAR}-${MONTH}-${DAY} ${HOUR}:${MINUTE}
* @Version 1.0
**/
public class ${NAME} {

}

接口注释模板文件与类相同

二、方法注释模板

  1. 操作: File -> Settings - > Editor -> Live Templates -> 点击"+"号 -> 选择 Template Group
    在这里插入图片描述

  2. 新建组:命名为 userDefine

在这里插入图片描述

  1. 新建模板:选中你刚才创建的组,然后右上角新建模板,命名为*

在这里插入图片描述
因为IDEA生成注释的默认方式是:/*+模板名+快捷键(比如若设置模板名为add快捷键用Tab,则生成方式为: /*add+Tab),如果不采用这样的生成方式IDEA中没有内容的方法将不可用,例如获取方法参数的methodParameters()、获取方法返回值的methodReturnType()

在这里插入图片描述

  1. 添加方法模板内容:
*
 * @description:
 * @author: dazhong2012
 * @date: $date$ $time$
 * @param: $param$
 * @return: $return$
 **/
  1. 设置模板应用场景
    点击模板页面最下方的警告,来设置将模板应用于那些场景,一般选择EveryWhere–>Java即可

(如果曾经修改过,则显示为change而不是define)
在这里插入图片描述
6、设置参数
把右侧的 Expand with:改为Enter ;然后选择右侧的 Edit variables 按钮

在这里插入图片描述

  1. 设置成功后点击OK,返回项目新建一个方法,写完入参和返回值以后,在方法上面: 敲出:/** 回车(Enter 键)
    在这里插入图片描述

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

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

相关文章

2024年上半年信息系统项目管理师下午真题及答案(第二批)

试题一 某项目计划工期为10个月,预算210万元,第7个月结束时,项目经理进行了绩效评估,发现实际完成了总计划进度的70%。项目的实际数据如表所示: 单击下面头像图片领取更多软考独家资料

【Ambari】Docker 安装Ambari 大数据单机版本

目录 一、前期准备 1.1 部署 docker 1.2 部署 docker-compose 1.3 版本说明 二 、镜像构建启动 2.1 系统镜像构建 2.2 安装包源镜像构建 2.3 kdc镜像构建 2.4 集群安装 2.5 容器导出为镜像 三、Ubuntu环境安装测试 3.1 环境准备 3.2 集群容器启动 一、前期准备 1.…

【C++题解】1125. 删除字符串中间的*

问题:1125. 删除字符串中间的* 类型:字符串 题目描述: 输入一个字符串,将串前和串后的*保留,而将中间的 * 删除。 输入: 一个含*的字符串。 输出: 删除了串中的*的字符串。 样例&#xf…

夏日防晒笔记

1 防晒霜 使用方法:使用前上下摇晃瓶身4至5次,在距离肌肤10至15cm处均匀喷上。如在面部使用,请先喷在掌心再均匀涂抹于面部。排汗量较多时或擦拭肌肤后,请重复涂抹以确保防晒效果。卸除时使用普通洁肤产品洗净即可。

C++:STL容器的学习-->string

C:STL容器的学习-->string 1. 构造方法2. string的赋值操作3. string字符串的拼接4. string 查找和替换5. string字符串的比较6. string字符存取7. string 插入和删除8. string截取 需要添加头文件#include <string> 1. 构造方法 string() 创建空的字符串 string(c…

kafka3.6.1版本学习

kafka目录结构 bin linux系统下可执行脚本文件 bin/windows windows系统下可执行脚本文件 config 配置文件 libs 依赖类库 licenses 许可信息 site-docs 文档 logs 服务日志 启动ZooKeeper 进入Kafka解压缩文件夹的config目录&#xff0c;修改zookeeper.properties配置文件 #t…

深度学习模型在OCR中的可解释性问题与提升探讨

摘要&#xff1a; 随着深度学习技术在光学字符识别&#xff08;OCR&#xff09;领域的广泛应用&#xff0c;人们对深度学习模型的可解释性问题日益关注。本文将探讨OCR中深度学习模型的可解释性概念及其作用&#xff0c;以及如何提高可解释性&#xff0c;使其在实际应用中更可…

企业微信hook接口协议,ipad协议http,语音转文字

语音转文字 参数名必选类型说明uuid是String每个实例的唯一标识&#xff0c;根据uuid操作具体企业微信msgid是int要转文字的语音消息id 请求示例 {"uuid":"a4ea6a39-4b3a-4098-a250-2a07bef57355","msgid":1063645 } 返回示例 {"data&…

App Inventor 2 Encrypt.Security 安全性扩展:MD5哈希,SHA/AES/RSA/BASE64

这是关于App Inventor和Thunkable安全性的扩展&#xff0c;它提供MD5哈希&#xff0c;SHA1和SHA256哈希&#xff0c;AES加密/解密&#xff0c;RSA加密/解密&#xff0c;BASE64编码/解码方法。 权限 此扩展程序不需要任何权限。 事件 OnErrorOccured 抛出任何异常时将触发此事件…

20240527画图-筛选较长、均长、正交的基向量

1. LLM网址和prompt deepseek网址 prompt 请用python写出以下程序&#xff1a; 1、在x属于&#xff08;0&#xff0c;1920&#xff09;、y属于&#xff08;0&#xff0c;1080&#xff09;范围内&#xff0c;随机生成100个点&#xff0c;并画图 2、从这些点中选取3个点&#…

CC1链补充-LazyMap

前言 在我们上一篇中详细分析了CC1链&#xff0c;但是在CC1链中还有一条链就是LazyMap类 1.安装和CC1核心 环境安装的详情可以见上篇CC1分析的第二部分&#xff0c;环境搭建部分 两条不同的路线其实第一步核心都是相同的&#xff0c;执行类都是Tansformer接口和实现类&#…

操作系统 - 进程与线程

进程与线程 考纲内容 进程与线程 进程与线程的基本概念&#xff1b;进程/线程的状态与转换 线程的实现&#xff1b;内核支持的线程&#xff0c;线程库支持的线程 进程与线程的组织与控制 进程间通信&#xff1b;共享内存&#xff0c;消息传递&#xff0c;管道CPU调度与上下文…

VectorDBBench在windows的调试

VectorDBBench在windows的调试 VectorDBBench是一款向量数据库基准测试工具&#xff0c;支持milvus、Zilliz Cloud、Elastic Search、Qdrant Cloud、Weaviate Cloud 、 PgVector、PgVectorRS等&#xff0c;可以测试其QPS、时延、recall。 VectorDBBench是一款使用python编写的…

计算机毕业设计hadoop+spark+hive知识图谱音乐推荐系统 音乐数据分析可视化大屏 音乐爬虫 LSTM情感分析 大数据毕设 深度学习 机器学习

青岛理工大学&#xff08;临沂&#xff09;机械与电子工程系 毕业设计外文翻译 独立于语言的个性化音乐 推荐系统 Personalized Language-Independent Music Recommendation System 设计题目&#xff1a;基于python的音乐推荐系统的分析可视化设计 …

如何连接远程?

在现代信息技术的发展过程中&#xff0c;不同地区之间的远程连接变得日益重要。为了满足不同地区的电脑、设备之间的信息远程通信需求&#xff0c;北京金万维科技有限公司自主研发的【天联】组网产品应运而生。【天联】是一款异地组网内网穿透产品&#xff0c;可以在任何网络环…

C语言 数组——排序算法的函数实现

目录 交换法排序 用交换法对成绩数组升序排序 选择法排序 冒泡法排序 归并法排序 交换法排序 用交换法对成绩数组升序排序 选择法排序 冒泡法排序 归并法排序

数据结构(四)双向链表

文章目录 一、概念二、无头双向链表示意图三、操作&#xff08;一&#xff09;定义结构体&#xff08;二&#xff09;创建链表1. 函数定义2. 注意点3. 代码实现 &#xff08;三&#xff09;插入1. 函数定义2. 注意点3. 代码实现 &#xff08;四&#xff09;删除1. 函数定义2. 注…

【Python】 如何在Python中设置环境变量?

基本原理 在Python中&#xff0c;环境变量是一种存储系统或应用程序配置信息的方式&#xff0c;它们可以被操作系统或应用程序访问。环境变量通常用于配置应用程序的行为&#xff0c;例如指定数据库的连接字符串、API密钥、文件路径等。 Python提供了几种方法来设置和访问环境…

最后两天!百度云加速正式停服

百度云加速将于5月30日&#xff0c;正式关闭服务器&#xff0c;仅保留官网首页通知。 届时如网站还在百度云加速接入的&#xff0c;将无法正常访问&#xff01; 如果您还有域名在百度云加速接入的请尽快做迁移安排&#xff0c;以免造成损失。 目前在主机吧购买的域名已经全部…

Flink本地idea运行环境配置webui

Flink本地idea运行环境配置webui 1.添加依赖 <dependency><groupId>org.apache.flink</groupId><artifactId>flink-runtime-web_2.11</artifactId><version>1.13.6</version><scope>provided</scope></dependency&g…