IntelliJ Idea注释模板--类注释、方法注释
刚从Eclipse切换到IntelliJ Idea,之前使用eclipse时用到了注释模板,包括类注释和方法注释,现在分别讲一下在Intellij Idea中如何进行配置,作为备忘
一. 类注释模板配置
1. 配置效果
2. 配置方法
【File】-->【settings】-->【Editor】-->【File and Code Templates】-->【Files】-->【Class】
一. 类注释模板配置
1. 配置效果
注意:关于参数的注释,网上有一些配置是将多个参数列在一行,形如:@param [a, b],当然网上也提供了将多个参数列成多行的形式,即上图所示效果,这是用脚本实现的,但是网上的脚本因空格问题,老是对不齐,本人有强迫症,修改了一下(起始就是去了个空格),使之对的比较整齐,如上图所示效果。
2. 配置方法
IDEA还没有智能到自动为我们创建方法注释,这就是要我们手动为方法添加注释,使用Eclipse时我们生成注释的习惯是:/**+Enter,这里我们也按照这种习惯来设置IDEA的方法注释。
(1)打开页面配置
(2)创建模板组
【Editor】 --> 【Live Templates】 --> 【点击“+”】 --> 【Template Group】 --> 【输入名称,点击OK(我输入的是My Group)】,如下图中步骤1~4
(3)创建模板
选中新建的模板组(My Group) --> 点击“+” --> 1.Live Template,如上图中步骤5~6
(4)模板设置:
- 1.设置模板前缀,如果设置为,使用时 /* + Enter键(第5步设置该按键),如果设置为a,使用时 /*a + Enter键,其他类推
- 2.设置该模板应用范围,mothed表示方法,file表示类上面
- 3.填写模板内容,具体内容会在后面补充,可以参考
- 4.设置模板中变量的取值
- 5.设置执行按键,默认是Tab,我一般习惯改为Enter键。该功能主要配合步骤1中的模板前缀使用
- 6.设置模板应用范围,一般是点击第一个进行全选操作。
(5)模板内容
设置模板内容,如上图步骤3位置所示:
*
* @Description TODO
$params$
* @Return $return$
* @Author duzhijie
* @Date $date$ $time$
**/
(6)设置模板变量的取值,对应上图步骤4操作,如下
在这里设置模板变量取值,或者用脚本,或者用idea自带的方法,如
方法参数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) ? '\\r\\n' : '')}; return result", methodParameters())
注意:只有用这个脚本,多个参数才是才是各占一行,如果用 methidParameters(),则多个参数会只占一行,形如:@param [a, b],
IntelliJ Idea注释模板--类注释、方法注释的更多相关文章
- idea 模版之自定义类与方法注释
idea 模版之自定义类与方法注释 很多公司都有要求的代码注释规范,我们每新建类或者方法的时候从新复制粘贴很麻烦,而且容易粘错. 当然自定义模板还可以用到很多地方,比如系统自带的 sout就是syst ...
- c++ 模板类,方法返回值类型是typedef出来的,或者是auto,那么此方法在类外面如何定义?
c++ 模板类,方法返回值类型是typedef出来的,或者是auto,那么此方法在类外面如何定义? 比如方法max1的返回值是用typedef定义出来的mint,那么在类外如何定义这个方法呢? tem ...
- IDEA设置类、方法注释模板
类注释模板 File -> Other Setting -> Default Setting打开默认设置 Editor -> File and Code Templates -> ...
- IntelliJ IDEA 类和方法注释的生成以及Javadoc的简单使用记录
idea,设置类注释和,方法注释的常见的设置方法(不同的版本设置方法有所偏差,简单记录一些目前自己在使用的方法,) 方法注释:在keyMap中搜索Fix doc comment ,后点击右键设置一个快 ...
- IDEA配置类和方法注释模板
1定义java文件头部的注释 2给java类中的方法添加上注释 2.1第一步勾选Enable Live Templates 2.2第二步新建一个Group 2.3第三步新建一个Template 2. ...
- IDEA类和方法注释模板设置
在开发中使用idea的注释总结:由于IDEA自带的注释模板不是太好用,所以整理一下适用于自己的模板: 一.首先我们来设置IDEA中类的模板:(IDEA中在创建类时会自动给添加注释) 1.File--& ...
- IDEA类和方法注释模板设置(非常详细)
一.首先我们来设置IDEA中类的模板:(IDEA中在创建类时会自动给添加注释) 1.File-->settings-->Editor-->File and Code Template ...
- idea中添加类和方法注释以及codeCheck
前言:在idea中我们添加类以及类的方法的注释很有必要,让其他人能够看懂这个类或者函数的作用是什么:为了在开发过程中检查自己的编程规范,可以通过codecheck工具进行自我检查和约束 一.在idea ...
- IntelliJ IDEA for MAC 注释模板、快捷键生成注释
增加注释 在IntelliJ IDEA中为JAVA代码增加注释,首先需要配置注释模板,而后使用模板快捷键生成注释, 下面按照[配置模板].[模板使用]两部分进行介绍 ----------------- ...
随机推荐
- dj cookie与session 2
def login_session(request): if request.method == "POST": user = request.POST.get("use ...
- Netty4.x 源码实战系列(一): 深入理解ServerBootstrap 与 Bootstrap
转载自:https://www.cnblogs.com/itdriver/p/8149913.html 从Java1.4开始, Java引入了non-blocking IO,简称NIO.NIO与传统s ...
- python coroutine的学习跟总结[转]
简介 因为最近一段时间需要研究一些openstack相关的东西,在阅读一些相关代码的时候碰到很多python特定的一些特性,比如generator, coroutine以及一些相关的类库,比如even ...
- Java Applet在IE中浏览
1. IE --> 工具 --> Internet选项 --> 取消“将Java1.6.0.4加入Internet”选择项. 2. 开始 --> 控制面板 --> Jav ...
- bzoj3262(cdq分治模板)
裸的cdq,注意去重: #include<iostream> #include<cstdio> #include<cmath> #include<cstrin ...
- HashMap原理、源码、实践
HashMap是一种十分常用的数据结构,作为一个应用开发人员,对其原理.实现的加深理解有助于更高效地进行数据存取.本文所用的jdk版本为1.5. 使用HashMap <Effective JAV ...
- Java 是值传递
本质:传值/传地址值 以下搬运自知乎大佬 作者:Intopass链接:https://www.zhihu.com/question/31203609/answer/50992895来源:知乎著 ...
- [ 9.13 ]CF每日一题系列—— 340A GCD & LCM
Description: [ 着实比较羞愧,都想着去暴力,把算法(方法)也忘了] A只涂x,2x,3x……,B只涂y,2y,3y……问你A和B共同涂的墙的个数 Solution: 就是求x和y的lcm ...
- MEAN 27
添加评论主题页,在26的基础上. 新建了很多文件 Error: Cannot find module './controllers/customers_c' 解决办法:../ 接下来做function ...
- php+sqlserver之如何操作sqlserver数据库
https://blog.csdn.net/xia13100004562/article/details/58598872 2016年12月19日 17:15:39 阅读数:6790 前面已经基本配置 ...