IDEA设置注释模板最佳实践

效果

在方法上输入/**,然后按tab键,生成的效果如下

配置步骤

1. 在Live Templates中添加模板组,命名随意,主要是为了存放自定义的模板,方便管理

2. 在模板组下添加一个模板,具体配置如下

1. Abbreviation 填写 *

(注:曾经我填写的是/** ,发现拦截/**会导致某些情况下无法获取对应参数的)

2. Template text 填写

*
 *
 *
 $param$
 * @author XxxYyyZzz
 * @date $date$
*/ 

3. 点击Edit variables,date字段选择date(),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()) 

4. 在Expand with中选择tab,然后点击Apply即可

(也可选择其他按键,表示触发的按键,个人比较喜欢用tab,避免与原有按键冲突)

原文地址:https://www.cnblogs.com/leap/p/9631702.html

时间: 2024-10-08 09:58:25

IDEA设置注释模板最佳实践的相关文章

MyEclipse6.5设置注释模板的日期为中文格式

/** * MyEclipse6.5设置注释模板的日期为中文格式 * --------------------------------------------------------------------------------------------------------------- * 相信大部分人都用过Eclipse/MyEclipse中的Code Templates功能,配置地址如下 * Windows-->Preferences-->Java-->Code Style--

IDEA中设置注释模板的方法

IDEA中设置注释模板主要分为两个部分,分别是创建java文件时类的注释和方法的注释. 这里为大家详细介绍一下方法,按MyEclipse的风格设置(MyEclipse的请看:MyEclipse中设置注释模板的方法),大家可以根据自己的习惯生成自己喜欢的注释模板.效果如下: 一.设置类的注释模板 1.选择File→Settings→Editor→File and Code Templates→Files→Class.可以看到创建Class时引入了一个参数"File Header.java"

MyEclipse设置注释模板

之前用VisualStudio的时候,可以为类.方法等自动生成风格统一的注释,既然"风格统一",那么就可以把它们抽象出一套模板.在MyEclipse中同样可以自动生成注释. 只有两个步骤: 1.设置模板 Windows-Preference-Java-Code Style-Code Templates 图中, Configure generated code and comments中的每种被注释的类型,都可以在下面Pattern中预览其注释模板,如果需要修改,点击右上角的 edit

CentOS 6.X设置环境时间最佳实践

服务器的时间在平时不起眼,但绝对是不可忽视的一个因素:例如 (1)服务器之间不同步,服务器之间的验证会失败,会导致整个系统不能用: (2)对于数据库服务器记录的数据日志时间有偏差,遇到电商的秒杀活动,这损失的金钱可能就以百万计: -- 例子很多就不一一列举,言归正传, 一.设置适合的时区 正在本机上生效的失去文件是/etc/localtime (1)查看本机上保存的时区文件 ls -R /usr/share/zoneinfo/ (2)只要将/usr/share/zoneinfo中相应的文件覆盖/

Eclipse设置注释模板和工作空间背景色为豆沙绿

Eclipse Version: Photon Release (4.8.0). 首先上图,根据图上的步骤即可完成注释模板的设置. 1 如何设置eclipse注释模板的日期格式 在eclipse的 Preference -> Java -> Code Style -> Code Templates 的javadoc中,我们往往会自定义自己的javadoc的模板.如下: /** * @Title ${enclosing_method} * @Description ${todo} * @A

[IDEA]IDEA设置注释模板

IDEA的注释模板有类注释模板和方法注释模板两种,下面分别介绍: 一.类注释模板 菜单路径:File->Settings->Editor->File and Code Templates 类模板代码: /** *@description: *@projectName:${PROJECT_NAME} *@see:${PACKAGE_NAME} *@author:郑晓龙 *@createTime:${DATE} ${TIME} *@version:1.0 */ 二.方法注释模板 菜单路径:F

eclipse 中设置注释模板

使用eclipse进行开发,尤其是团队开发,编码规范很重要: 如何配置注释的格式: eclipse-windows-preferences-java-codeStle-CodeTemplate-Comments 进行配置即可 types如何配置:是配置类的说明 /** * <p> ${todo}(这里用一句话描述这个类的作用) </p> * <p>日期: ${date} ${time} </p> * @author ${user} * @version V1

idea 设置注释模板

1. 准备模板 /** * * 功能描述: * * @Author sun * @Description //TODO $end$ * @Date $time$ $date$ * @Param $param$ * @return $return$ **/ 2. 进入file --> setting -->live templates 下 点击右侧的 + 号新建 template group 取个任意的名字,然后在点+ 号 点 live template 进去 设置 Abbreviation 设

Eclipse注释模板设置详解

设置注释模板的入口:Window->Preference->Java->Code Style->Code Template 然后展开Comments节点就是所有需设置注释的元素.本文现就每一个元素逐一给大家介绍一下. 文件(Files)注释标签: 1 2 3 4 5 6 7 8 /** * @Title: ${file_name} * @Package ${package_name} * @Description: ${todo}(用一句话描述该文件做什么) * @author $