Idea:通过Live Template自定义模板(类注释、方法注释)

本文涉及的产品
视频直播,500GB 1个月
简介: Idea:通过Live Template自定义模板(类注释、方法注释)

目录

1.选择Live Template

2.创建自定义Template Group

3.创建自定义Live Template

4.设置模板 内容

类注释-方式1

类注释-方式2

方法注释

5.模板使用

备注

Javadoc 需要熟知的注释标签:

IDEA标签


1.选择Live Template

File-Settings--Editor--Live Template


2.创建自定义Template Group

点击右边的+号,选择Template Group,输入名称,比如user

 

3.创建自定义Live Template

选中刚才新建的user,再次点击绿色+号,选择Live Template,起个名,比如cc(类注释),mc(方法注释)


4.设置模板 内容

点击Edit variables按钮,选择idea提供的表达式,最后Apply

类注释-方式1

/**
 * @Title:
 * @ClassName: $PackageName$.$ClassName$.java
 * @Description:
 *
 * @Copyright 2016-2018 公司名称 - Powered By 研发中心
 * @author: 作者名
 * @date:  $DATE$ $TIME$
 * @version V1.0
 */
  • 其中变量属性


类注释-方式2

通过idea文件头方式,每次创建文件自动生成

第一步、File -> Settings

第二步、Editor -> File and Code Templates -> Includes -> File Header

模板:

/**
 * @Title:
 * @BelongProjecet ${PROJECT_NAME} 
 * @BelongPackage ${PACKAGE_NAME}
 * @Description: 
 *
 * @Copyright 2019 公司名 - Powered By 研发一部
 * @Author: 作者名
 * @Date:  ${DATE} ${TIME}
 * @Version V1.0
 */

方法注释

 

/**
 * @Title:  
 * @MethodName:  $methodName$
$param$
 * @Return $returns$
 * @Exception $exception$
 * @Description:
 *
 * @author: 作者名
 * @date:  $date$ $time$
 */
  • 其中变量属性

注意,这里param(方法参数)变量,由于idea没有提供这个属性,我们采用的是自定义groovyScript脚本方式

param脚本

groovyScript("def result=''; def params=\"${_1}\".replaceAll('[\\\\[|\\\\]|\\\\s]', '').split(',').toList(); for(i = 0; i < params.size(); i++) {result+=' * @param ' + params[i] + ((i < params.size() - 1) ? '\\n' : '')}; return result", methodParameters())

5.模板使用

类文件头部:cc+tab

方法头部:mc+tab

备注

Javadoc 需要熟知的注释标签:

@see 引用类/方法。

@author: 作者。

@date:日期。

@version: 版本号。

@throws:异常信息。

@param:参数

@return: 方法返回值。

@since: 开源项目常用此标签用于创建日期 。

{@value}: 会使用该值,常用于常量。

{@link} 引用类/方法。

{@linkplain} 与@link功能一致。

IDEA标签

${USER} : 当前用户。

${DATE} : 当前日期。

${PACKAGE_NAME}:包名。

${TIME}: 当前时间。

${YEAR}: 当前年。

${MONTH}:当前月。

${DAY}: 当前日。

${HOURS}: 当前小时。

${MINUTE}: 当前分钟



目录
相关文章
|
3天前
|
XML Java 数据格式
使用idea中的Live Templates自定义自动生成Spring所需的XML配置文件格式
本文介绍了在使用Spring框架时,如何通过创建`applicationContext.xml`配置文件来管理对象。首先,在resources目录下新建XML配置文件,并通过IDEA自动生成部分配置。为完善配置,特别是添加AOP支持,可以通过IDEA的Live Templates功能自定义XML模板。具体步骤包括:连续按两次Shift搜索Live Templates,配置模板内容,输入特定前缀(如spring)并按Tab键即可快速生成完整的Spring配置文件。这样可以大大提高开发效率,减少重复工作。
使用idea中的Live Templates自定义自动生成Spring所需的XML配置文件格式
|
1月前
|
Java Windows
IDEA不使用lombok,如何快速生成get和set方法
【11月更文挑战第10天】在 IntelliJ IDEA 中生成 `get` 和 `set` 方法有多种方式:通过菜单操作、使用快捷键或自定义模板。菜单操作包括选择“Code”菜单中的“Generate...”,快捷键为“Alt + Insert”。自定义模板可在“File”-&gt;“Settings”-&gt;“Editor”-&gt;“Code Style”-&gt;“Java”中设置。批量生成时,可多选变量一次性生成。
|
2月前
|
Java
IDEA 利用groovy脚本生成注释
【10月更文挑战第29天】在 IntelliJ IDEA 中,可以通过创建和运行 Groovy 脚本来自动生成 Java 类方法的 Javadoc 注释。首先,创建一个 Groovy 文件并编写脚本,该脚本会检查每个方法是否已有注释,如果没有,则生成包含方法描述、参数列表和返回值的基本注释。接着,通过“Tools”菜单下的“Groovy Console”运行脚本,确保脚本中的包版本与当前使用的 IntelliJ IDEA 版本匹配。运行后,脚本将自动为选定类的方法添加注释。建议在执行前备份代码,以防意外。
|
2月前
|
SQL 存储 关系型数据库
MySQL 与 IntelliJ IDEA 同时兼容的注释
MySQL 与 IntelliJ IDEA 同时兼容的注释
51 2
|
3月前
|
Java 应用服务中间件 Spring
IDEA 工具 启动 spring boot 的 main 方法报错。已解决
IDEA 工具 启动 spring boot 的 main 方法报错。已解决
|
2月前
|
Java
IDEA自定义配置注释模板,让你看起来更加专业!!!
IDEA自定义配置注释模板,让你看起来更加专业!!!
116 0
|
4月前
|
XML 数据格式
IDEA 行注释设置,使其不从顶格开始,让其处于代码前开始
这篇文章提供了IntelliJ IDEA中如何设置行注释不从顶格开始,而是紧接在代码前面的方法,通过访问Settings中的Code Style选项进行调整,以改善代码注释的视觉效果。
|
4月前
|
Java
Java系列之 IDEA 为类 和 方法设置注解模板
这篇文章介绍了如何在IntelliJ IDEA中为类和方法设置注解模板,包括类模板的创建和应用,以及两种不同的方法注解模板的创建过程和实际效果展示,旨在提高代码的可读性和维护性。
|
API C++ Windows
【Live555】Live555 Windows下使用VS2017编译教程
【Live555】Live555 Windows下使用VS2017编译教程
【Live555】Live555 Windows下使用VS2017编译教程
|
数据建模 C++ Windows
live555开发笔记(一):live555介绍、windows上msvc2017编译和工程模板
live555开发笔记(一):live555介绍、windows上msvc2017编译和工程模板
live555开发笔记(一):live555介绍、windows上msvc2017编译和工程模板