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

简介: 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}: 当前分钟



相关文章
|
XML Java 数据格式
使用idea中的Live Templates自定义自动生成Spring所需的XML配置文件格式
本文介绍了在使用Spring框架时,如何通过创建`applicationContext.xml`配置文件来管理对象。首先,在resources目录下新建XML配置文件,并通过IDEA自动生成部分配置。为完善配置,特别是添加AOP支持,可以通过IDEA的Live Templates功能自定义XML模板。具体步骤包括:连续按两次Shift搜索Live Templates,配置模板内容,输入特定前缀(如spring)并按Tab键即可快速生成完整的Spring配置文件。这样可以大大提高开发效率,减少重复工作。
1317 1
使用idea中的Live Templates自定义自动生成Spring所需的XML配置文件格式
|
设计模式 数据可视化 Java
如何在 IDEA 中设置类路径
在 IntelliJ IDEA 中设置类路径,可以通过项目结构配置或模块设置来添加所需的库和依赖。具体步骤包括打开项目结构对话框、选择模块、添加类路径等。
3228 18
(详细图解过程) IDEA在创建类的的时候自动生成作者信息、时间等信息
这篇文章介绍了如何在IntelliJ IDEA中设置文件和代码模板,以便在创建新类时自动生成包含作者信息、日期和时间等信息的文件头。
(详细图解过程) IDEA在创建类的的时候自动生成作者信息、时间等信息
|
Java 数据库连接 Spring
如何在IDEA中自定义模板、快速生成完整的代码?
这篇文章介绍了如何在IntelliJ IDEA中使用easycode插件自定义代码生成模板,以快速生成Spring Boot、MyBatis等项目中常见的Controller、Service、Dao、Mapper等组件的代码。
如何在IDEA中自定义模板、快速生成完整的代码?
|
人工智能 Java 数据库连接
IDEA开发 常用代码规范插件 常用辅助类插件
IDEA开发 常用代码规范插件 常用辅助类插件
2204 1
Java系列之 IDEA 为类 和 方法设置注解模板
这篇文章介绍了如何在IntelliJ IDEA中为类和方法设置注解模板,包括类模板的创建和应用,以及两种不同的方法注解模板的创建过程和实际效果展示,旨在提高代码的可读性和维护性。
|
搜索推荐 Java Maven
Netbeans入门实践类IDEA风格下
Netbeans入门实践类IDEA风格下; 配置文件模板Templates, user, date, time; 解决Open Project, 中文乱码GBK
420 1
|
Java Spring
idea新建spring boot 项目右键无package及java类的选项
idea新建spring boot 项目右键无package及java类的选项
1068 5
|
IDE Java Apache
Netbeans入门实践类IDEA风格上
Java IDE, NetBeans, IDEA, Eclipse, Netbeans入门实践类IDEA风格上篇 遇到并解决问题1, NetBeans Error, Cannot find Java 1.8 or higher.
426 1
|
SQL Java 数据库连接
idea中配置mybatis 映射文件模版及 mybatis plus 自定义sql
idea中配置mybatis 映射文件模版及 mybatis plus 自定义sql
778 3