IDEA中如何设置文件头注释和方法注释(详解)
文件头注释和方法注释的两种方式
方法一:
文件头注释:
打开File–>Settings–>Editor–>File and Code Templates–>includes–>File Header
1.第一步点击File
2.找到File中的Settings
3.Settings去找到Editor中的File and Code Templates后
4.找到includes去添加File Header
5.最后在右边的编辑栏里进行注释需要编辑的内容
6.以上操作完成后,点击Apply应用,再点击OK就可完成文件头注释的操作啦
我们在右边的文件框里进行需要添加的编辑内容,然后应用保存之后,当你创建一个新的类的时候它就会自动生成文件头的注释,以上就可以完成操作啦
方法注释:
打开file->setting->Editor->Live Templates点击右边上面那个+ 号,选择Template Group双击,然后弹出一个窗口,随便添加一个新的名字,我这里添加的是NewGroup 然后点击OK
一、点击File 找到Settings打开
二、Settings中选择Live Templates
三、点击最右边的加号+选择2.Template Group…即可添加一个新的模块
四、点击之后会弹出一个窗口去编辑模块的内容,随便添加一个新的名字,添加完成点击OK
还是在file->setting->Editor->LiveTemplates这个路径下点击一下刚刚你添加的那个名字(我这是MyGroup),然后点击右边上面那个绿色的+号,选择LiveTemplate双击,填写下面的图上的框
点击完Define之后
点击Everywhere选择全部选项
最后一步:找到右下角的Edit variables,然后弹出如下图的窗口:
如果想把@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\b’ : ‘’)}; return result", methodParameters())
下面红色圈中的下拉框中直接去选择相对应的参数点击OK
接下来再点击Apply,点击OK即可使用啦
在写方法之前点写上add(自己定义的名字)再按tab键,注释就可以自动生成出来了哦!!!
方法二:
这些方法都是根据一个博客的一位小哥哥写的博客进行操作的,觉得方法很好用,自己将这些好的方法写成博客以便于以后查看,也希望能够有需要的小哥哥小姐姐们快速找到节省时间啦
下面的注释模板采用的是Eclipse的格式,贴出来的是Eclipse的注释模板,我们也可以按照这种格式进行设置:
这是关于类注释的模板:
这是关于方法注释的模板:
一、我们需要去设置IDEA中类的模板: (IDEA中再创建新的类时会自动给添加注释)
一、File–>settings–>Editor–>File and Code Templates–>Files 二、我们选择Class文件(需要设置接口的话也可以选择Interface文件)
(1)N A M E : 设 置 类 名 , 与 下 面 的 {NAME}:设置类名,与下面的NAME:设置类名,与下面的{NAME}一样才能获取到创建的类名(2)TODO:代办事项的标记,一般生成类或方法都需要添加描述(3)${USER}、${DATE}、${TIME}:设置创建类的用户、创建的日期和时间,这些事IDEA内置的方法,还有一些其他的方法在绿色框标注的位置,比如你想添加项目名则可以使用${PROJECT_NAME}(4)1.0:设置版本号,一般新创建的类都是1.0版本,这里写死就可以了
这就是完成操作的整个步骤哦,如下图:
效果图如下
二、设置方法的注释方法:
IDEA需要我们手动为方法添加注释,使用Eclipse时我们生成注释的习惯是/**+Enter,我们就按照这种习惯来设置IDEA的方法注释
1、 File->Settings->Editor->Live Templates
(1)、新建组:命名为addDefine
1.点击+号,选择第2个
2.选择完之后定义新的命名
(2)新建模板:命名为*
因为IDEA生成注释的默认方式是:/*+模板名+快捷键(比如若设置模板名为add快捷键用Tab,则生成方式为 /*add+Tab),如果不采用这样的生成方式IDEA中没有内容的方法将不可用,例如获取方法参数的methodParameters()、获取方法返回值的methodReturnType()
(3) 设置生成注解的快捷键
(4)设置模板:模板内容如下(注意:第一行,只有一个而不是/)
在设置参数名时必须用参数名的方式,否则第五步中读取不到你所需要设置的参数名
(5)设置参数的获取方式
选择右侧的Edit variables按钮
选择每个参数对应的获取方法(在下拉选择框中选择即可),网上有很多教程说获取param时使用脚本的方式,我试过使用脚本的方式,不仅麻烦而且只能在方法内部使用注释时才能获取到参数
(6)设置模板的应用场景
点击模板页面最下方的警告,来设置将模板应用于那些场景,一般选择EveryWhere–>Java即可
(如果曾经修改过,则显示为change而不是define)
(7)放上我们的效果图吧
创建方法时,在方法上面写:/*+模板名+Enter->/**+Enter
两种方法都已经大功告成啦,收工了哦!!!两种方法亲测有效,特别实用的,快去试试吧小哥哥小姐姐们!!!
IDEA中如何设置文件头注释和方法注释(详解)相关推荐
- js中几种实用的跨域方法原理详解
这里说的js跨域是指通过js在不同的域之间进行数据传输或通信,比如用ajax向一个不同的域请求数据,或者通过js获取页面中不同域的框架中(iframe)的数据.只要协议.域名.端口有任何一个不同,都被 ...
- java判断一个对象是否为空_Java中判断对象是否为空的方法的详解
首先来看一下工具StringUtils的判断方法: 一种是org.apache.commons.lang3包下的: 另一种是org.springframework.util包下的.这两种StringU ...
- html引入php文件中的函数,手把手教你在html中引入另一个html文件的方法(详解)...
html中引入调用另一个html的方法,尝试了好几种,都列出来: 其中第一种是最好的,其他的方法,可以尝试看看,是不是适合你当前项目 一.p+$("#page1").load(&q ...
- html获取cookiejs,javascript设置和获取cookie的方法实例详解
本文实例讲述了javascript设置和获取cookie的方法.分享给大家供大家参考,具体如下: 1. 设置cookie function setCookie(cookieName,cookieVal ...
- 微星主板黑苹果_技嘉X79-UD7主板设置一键启动u盘方法【详解】
技嘉主板一键启动u盘的快捷键是什么?X79-UD7型号的技嘉主板如何设置u盘启动?今天IT百科教大家技嘉X79-UD7主板的一键启动u盘的方法. 首先插入已经使用 u启动 制作好启动盘的u盘到电脑主机 ...
- idea 设置自动生成类和方法注释,TODO标记作者日期信息以及过滤自己所写标记
HAI,这是我的第一篇博客; 一直都是在csdn上学习,有所收获也应该写博客回报猿友们: 今天写一篇分享如何配置idea的类注释和方法注释(遵循阿里开发规范),还有todo注释(这个也很重要,谁的问题 ...
- Intellj Idea 如何设置类头注释和方法注释
intellj idea 如何设置类头注释和方法注释 intellj idea的强大之处就不多说了,相信每个用过它的人都会体会到,但是我们也会被他的复杂搞的晕头转向,尤其刚从eclip ...
- idea设置类注释和方法注释(贼详细)
为了规范代码开发,我们需要用到开发工具的设置,比如类注释和方法注释的模板. 先说说在idea中如何设置类注释吧,第一步需要打开设置: 第二步打开文件和代码模板设置,并且找到类模板: /*** @Des ...
- IntelliJ IDEA设置类注释和方法注释模板
IntelliJ IDEA设置类注释和方法注释模板 1.设置类注释模板 这样在定义类时,都要多输入类的描述.不想的话,可以删去 ${description} 2.方法注释模板 先新建模板组,名字自己起 ...
最新文章
- mysql-atlas安装及使用教程
- C++学习之路: 单例模板
- Ubuntu16.04 卸载Gazebo7 安装 Gazebo9
- Unable to locate tools.jar
- python查询模块路径_Visual Studio 2017中的Python无法通过“搜索路径”查找模块
- RocketMQ 端云一体化设计与实践
- 基于zookeeper实现分布式配置中心(二)
- Unable to load native-hadoop library解决思路
- 【LeetCode】剑指 Offer 67. 把字符串转换成整数
- 好用的 windows10 软件推荐
- jeecg框架表格合计解决方案
- python进阶之web前端(01—HTML超文本标记语言)
- 是的,你的AI技能正在“贬值”
- 【解决笔记本黑屏问题】
- 基于html篮球网页游戏,基于html5和jquery的篮球跳动游戏
- 超强正能量。不得不推荐的新歌 黑暗骑士(JJ、五月天)。
- 让AI玩俄罗斯方块 UCL ENGF2 CA4.1 作业
- python爬取mblock的图片素材
- 微信小程序AES解密失败
- PBOC MAC 计算算法 实现
热门文章
- Springboot集成websocket实现消息推送和在线用户统计
- 如何提升开发效率?用这些免费API就够了
- 2B SaaS的黏性在哪里?
- 用PIL实现滤镜(一)——素描、铅笔画效果
- ffmpeg ts section 表及pes表解释
- 《史蒂夫·乔布斯传》摘要首发:与伊夫二重唱
- 洛谷 P3868 [TJOI2009]猜数字【中国剩余定理】
- 【绝地求生】—— AI挖掘百万‘鸡王’的游戏数据,让你把把吃鸡
- 【scrapy实践】_爬取安居客_广州_新楼盘数据
- 长整型和整形数据运算的不同