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



相关文章
|
IDE 程序员 开发工具
只用正版!教你5个方法,白嫖JetBrains家族的所有产品,包含:IntelliJ IDEA、PyCharm、WebStorm、CLion、Rider
程序员晚枫分享了5种官方认证的免费使用JetBrains家族产品的方法,包括内容创作者计划、开源项目支持、教育许可证、用户组支持和开发者认可计划。这些方法帮助个人开发者与小型团队合法获取强大开发工具,如IntelliJ IDEA、PyCharm等,降低开发成本,提升效率。同时提醒大家遵守使用规范,尊重知识产权。
2995 13
|
人工智能 自然语言处理 Java
IDEA + 通义灵码 AI 程序员:快速构建 DDD 后端工程模板
本文介绍了如何利用 IntelliJ IDEA 编辑器和阿里云的通义灵码 AI 程序员,快速搭建一个基于 DDD 领域驱动架构的后端工程模板。
|
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”中设置。批量生成时,可多选变量一次性生成。
4699 2
|
搜索推荐 Java 数据库连接
Java|在 IDEA 里自动生成 MyBatis 模板代码
基于 MyBatis 开发的项目,新增数据库表以后,总是需要编写对应的 Entity、Mapper 和 Service 等等 Class 的代码,这些都是重复的工作,我们可以想一些办法来自动生成这些代码。
644 6
IDEA自定义配置注释模板,让你看起来更加专业!!!
IDEA自定义配置注释模板,让你看起来更加专业!!!
2588 0
|
Java Android开发
Idea使用系列之一:Idea设置类注释模板和方法注释模板
现在Idea越来越流行了,自己慢慢开始从Eclipse转向Idea开发。刚开始使用Idea,肯定会遇到各种各样的设置问题,所以在博客上专门有个文章系列进行记录,希望给转Idea开发的同学一点帮助。 设置类模板 设置方法模板
Idea使用系列之一:Idea设置类注释模板和方法注释模板
|
Java 应用服务中间件 Maven
在IntelliJ IDEA中如何配置使用Maven以创建Tomcat环境
所以,别担心这些工具看起来有些吓人,实际上这些都是为了帮助你更好的完成工作的工具,就像超市里的各种烹饪工具一样,尽管它们看起来可能很复杂,但只要你学会用,它们会为你烹饪出一道道美妙的食物。这就是学习新技能的乐趣,让我们一起享受这个过程,攀登知识的高峰!
879 27
|
Java 应用服务中间件 Apache
在IntelliJ IDEA中使用Maven配置Tomcat环境
此配置方法具有较高的实用性,简单易懂。遵循以上步骤,您将能顺利在IntelliJ IDEA中使用Maven配置Tomcat环境,从而进行Web项目的开发和调试。
1880 18
|
IDE Oracle Java
day4:JDK、IntelliJ IDEA的安装和环境变量配置
【7月更文挑战第4天】🏆本文收录于「滚雪球学Java」专栏,专业攻坚指数级提升,希望能够助你一臂之力,帮你早日登顶实现财富自由🚀;同时,欢迎大家关注&&收藏&&订阅!持续更新中,up!up!up!!
943 0

热门文章

最新文章