IntelliJ IDEA 通过文件代码模板自定义类注释
目录
- 前言
- 一、实现目标
- 二、操作环境
- 三、文件模板介绍
- 四、具体实现
- 1.进入文件代码模板管理配置界面
- 2.文件代码模板管理界面介绍
- (1) Scheme
- (2) 模板类型
- (3) 界面内容
- 3.自定义类注释模板
- (1) Class模板
- (2) File Header.java
- 总结
前言
《阿里巴巴Java开发手册》中注释规约就强制要求所有的类都必须添加创建者和创建日期。我们在日常开发中添加类注释也是非常好的编程习惯。本文就来介绍在 IDEA 中如何在新建类时自动添加类注释。
一、实现目标
IDEA 通过文件代码模板自定义类注释,在新建 Java 文件自动生成类注释,实现如下效果:
二、操作环境
- 操作系统:Windows 10
- IDE 工具:IntelliJ IDEA 2021.1.1
三、文件模板介绍
文件模板介绍直接引用官方:
文件模板是创建的新文件的默认内容的规范。根据正在创建的文件类型,模板提供了该类型的所有文件(根据行业或语言标准、公司政策或其他原因)中所期望的初始代码和格式。例如,这可以是样板代码、关于作者信息等等。
IntelliJ IDEA 为创建新文件时建议的所有支持的文件类型提供了预定义模板。建议的文件类型集取决于模块和配置,以及项目工具窗口中当前位置的属性。例如,IntelliJ IDEA 不会建议在Java源或测试目录之外创建 Java 类文件。
四、具体实现
1.进入文件代码模板管理配置界面
Ctrl+Alt+S/Settings --> Editor --> File and Code Templates
2.文件代码模板管理界面介绍
(1) Scheme
Scheme 设置有两个选项:Default 和 Project
- Default 范围控制应用于任何项目中整个工作区的模板。它们存储在
fileTemplates
下的 IDE 配置目录中。 - Project 范围控制只应用于当前项目的模板。它们存储在
.idea/fileTemplates
下的 project 文件夹中。这些模板可以在团队成员之间共享。
(2) 模板类型
IntelliJ IDEA 使用了几种类型的模板,分为以下选项卡:
- Files 选项卡包含用于创建新文件的文件模板。
- Includes 选项卡包含可插入到文件模板中的可重用内容(例如,一个特定的头应用于多个文件模板)。
- Code 选项卡包含 IntelliJ IDEA 用来生成各种构造的代码片段(片段)的内部模板。您可以编辑此选项卡上可用的代码段,但不能创建新的代码段。要创建自定义代码片段,请使用
Live Templates
。 - Other 选项卡包含各种应用服务器和框架使用的模板。您可以在此选项卡上编辑现有的内置模板,但不能创建新的模板。
(3) 界面内容
在每个选项卡下都有一下模块:模板列表、模板预览、描述。
- 模板列表:可以对模板进行新增、删除、复制等操作。
- 模板编辑:对选中模板内容进行编辑,通过勾选可以实现:
- 根据风格重新格式化
- 启用
Live Templates
- 描述:是对配置用法进行说明。
3.自定义类注释模板
(1) Class模板
Files 选项卡下载模板列表中选择 Class 。
在编辑区域看到的模板代码,在结合描述区域其实很好理解:
- 第一行代码:是用
#if
判断包名是否为空,不为空就将包名填写到此位置。 - 第二行代码:使用
#parse
插入了另一个名为File Header.java
的模板的内容。 - 第三行代码:是将文件名传递到此位置。
(2) File Header.java
配置的重点就在 File Header.java
文件。通过文件名或是该文件代码所在位置也可以知道这里可以配置类注释。
参考描述中的预定义变量,可以简单配置类注释。
/*** ${NAME}** @author Ongoing蜗牛* @since ${DATE} ${TIME}*/
直接将代码复制到编辑区域,点进【Apply】和【OK】。新建Java类进行验证,这里新建 ClassAnnotation.java
,效果如下:
总结
这里学习并记录…
参考官方网站文档…
应该为类添加类注释,好处多多…
阿里巴巴Java开发手册中注释规约就强制要求所有的类都必须添加创建者和创建日期…
配置模板在创建Java类后自动生成类注释,不必每次手写或复制…
IntelliJ IDEA 通过文件代码模板自定义类注释相关推荐
- idea 汉化版 自定义类注释与方法注释 解决自定义注解出现红线
1.添加自定义方法注释 演示用的idea 版本为2020.1 步骤一: 选择File ----Settings 步骤二: 选择 Live Templates----选择加号-选择 Template G ...
- android studio自定义类,为AndroidStudio设置自定义类注释
我们在使用eclipse的时候,只要在类上面输入/**再按enter,就会出现类注释. package com.demo; /** * * @author chenjunxu * */ public ...
- Intellij IDEA自定义类注释模板
/*** @title * @description* @author ${USER} *@createDate ${DATE} *@version 1.0*/ 设置以上内容以后 , 新建类时会自动添 ...
- IDEA超实用方法类注释模板大全
❤️❤️IDEA总结100篇(VIP典藏版2022)❤️❤️ 目录 一.自定义-方法注释模板 1. File >> Settings- >> Editor >> L ...
- Eclipse设置文件/方法/类注释及自定义注释风格
规范的代码,通常起到事半功倍的效果. 点击访问博客查看原文 自定义注释入口:Window->Preference->Java->Code Style->Code Templat ...
- idea的自定义模板(文件代码模板和文件注释说明文档)
1,idea自定义文件代码模板: (1)步骤:[File]->[Settings]->[Editor]->[File and Code Templates]->[复制 ]-&g ...
- IntelliJ IDEA自动生成自定义的类注释和方法注释
目录 自定义的类注释 自定义方法注释 实现效果:不用手写即可自动生成如下图的类上注释和方法上的注释,我们只需要填写方法注释的参数和返回值文字描述即可,大大节省了代码开发的时间提高代码开发效率. 自定义 ...
- IntelliJ IDEA设置类注释和方法注释
默认情况下,idea生成javadoc注释时,类上面使用时内容为空,方法上使用时会生成参数.返回值和抛出的异常,如果想显示@author.@date等信息时,则需要自己配置了. 一.类注释 方法一:创 ...
- 【Java文件操作(七)】序列化:将自定义类写入文件
我的博客--Java文件操作系列 [Java文件操作(一)]递归打印文件目录 [Java文件操作(二)]删除文件夹,但保留其内部文件 [Java文件操作(三)]递归复制文件夹内所有文件 [Java文件 ...
- IntelliJ Idea注释模板--类注释、方法注释
刚从Eclipse切换到IntelliJ Idea,之前使用eclipse时用到了注释模板,包括类注释和方法注释,现在分别讲一下在Intellij Idea中如何进行配置,作为备忘 一. 类注释模板配 ...
最新文章
- 本地打包Docker镜像上传至阿里云远程仓库(一站式脚本)
- 小功能 - 收藏集 - 掘金
- C++继承中构造函数、析构函数调用顺序及虚析构函数
- python windows系统调用_python日记第四章:python用os和sys模块进行系统调用
- linux grep 详细深入学习
- 如何在本地数据中心安装Service Fabric for Windows集群
- BZOJ 2003 [Hnoi2010]Matrix 矩阵
- PHPMailer - PHP email transport class
- 201706问题记录
- Linux二进制实用工具Binutils工具集解析()
- LeetCode Python实现 链表简单部分
- StringBuffer与StringBuilder的作用与区别
- windows日志 重要事件 id_操作系统日志简述
- 《java编程思想》读书笔记(二)第五章(2)
- python求解非递减排序的数组的一个旋转的最小元素
- Java 并发编程实战-创建和执行任务的最佳实践
- c语言cg平台答案,【2017年整理】非常好的C语言习题集带答案.doc
- 程序员修炼之道 通往务实的最高境界
- 数据库系统之初步认识数据库练习题
- 浅谈中国2050年人均受教育年限问题
热门文章
- ubuntu最佳分区方案(尤其是装多系统 win10+ubuntu18.04+ubuntu16.04)
- JavaEE初阶(11)HTTP 协议(发展历程、报文格式、URL、HTTP请求详解、HTTP 响应详解、构造HTTP请求、form 表单构造、AJAX的方式构造)
- 工欲善其事必先利其器-JVM相关参数、命令、常用工具
- IEEEtran模板 修改默认作者上标
- 【LLM】sft和pretrain数据处理和筛选方法
- PHPMailer 服务器发送邮件出现Could not connect to SMTP host错误 解决办法
- 记录一次清零SM2262EN固态硬盘,附SMART清零软件,SSD快速SMART清零教程
- android设置自定义颜色阴影效果,Android自定义图片圆角,增加渐变阴影
- 关于事务的四大特性和隔离级别,我是这样理解的
- 如何还原桌面图标_在Windows 7、8或10中还原丢失的桌面图标