IDEA类和方法注释模板设置
这里设置的注释模板采用Eclipse的格式,下面先贴出Eclipse的注释模板,我们就按照这种格式来设置:
类注释模板:
/**** @ClassName: TestType* @Description:* @Auther: cyj* @Date: 2018/7/9 09:08* @version : V1.0*/
方法注释模板:
/*** @Title* @Description: TODO* @auther: Administrator* @date: 2018/7/9 9:10* @return: java.lang.String*/
一、首先我们来设置IDEA中类的模板:(IDEA中在创建类时会自动给添加注释)
1、File–>settings–>Editor–>File and Code Templates–>Files
我们选择Class文件(当然你要设置接口的还也可以选择Interface文件)
(1) NAME:设置类名,与下面的 N A M E : 设 置 类 名 , 与 下 面 的 {NAME}:设置类名,与下面的{NAME}一样才能获取到创建的类名
(2)TODO:代办事项的标记,一般生成类或方法都需要添加描述
(3) USER、 U S E R 、 {USER}、{DATE}、 TIME:设置创建类的用户、创建的日期和时间,这些事IDEA内置的方法,还有一些其他的方法在绿色框标注的位置,比如你想添加项目名则可以使用 T I M E : 设 置 创 建 类 的 用 户 、 创 建 的 日 期 和 时 间 , 这 些 事 I D E A 内 置 的 方 法 , 还 有 一 些 其 他 的 方 法 在 绿 色 框 标 注 的 位 置 , 比 如 你 想 添 加 项 目 名 则 可 以 使 用 {TIME}:设置创建类的用户、创建的日期和时间,这些事IDEA内置的方法,还有一些其他的方法在绿色框标注的位置,比如你想添加项目名则可以使用{PROJECT_NAME}
(4)1.0:设置版本号,一般新创建的类都是1.0版本,这里写死就可以了
二、设置方法注释模板
IDEA还没有智能到自动为我们创建方法注释,这就是要我们手动为方法添加注释,使用Eclipse时我们生成注释的习惯是
/**+Enter,这里我们也按照这种习惯来设置IDEA的方法注释
1、File–>Settings–>Editor–>Live Templates
(1)新建组:命名为userDefine
(2)新建模板:命名为*
因为IDEA生成注释的默认方式是:/*+模板名+快捷键(比如若设置模板名为add快捷键用Tab,则生成方式为
/*add+Tab),如果不采用这样的生成方式IDEA中没有内容的方法将不可用,例如获取方法参数的methodParameters()、
获取方法返回值的methodReturnType()
(3)设置生成注释的快捷键
(4)设置模板:模板内容如下
注意第一行,只有一个而不是/
在设置参数名时必须用 参数名 参 数 名 {参数名}的方式,否则第五步中读取不到你设置的参数名
*
* @Author chengpunan
* @Description //TODO $end$
* @Date $time$ $date$
* @Param $param$
* @return $return$
**/
(5)设置参数的获取方式
选择右侧的Edit variables按钮
选择每个参数对应的获取方法(在下拉选择框中选择即可),网上有很多教程说获取param时使用脚本的方式,我试过使用脚本
的方式不仅麻烦而且只能在方法内部使用注释时才能获取到参数
(6)设置模板的应用场景
点击模板页面最下方的警告,来设置将模板应用于那些场景,一般选择EveryWhere–>Java即可
(如果曾经修改过,则显示为change而不是define)
(7)效果图
创建方法,在方法上面写:/+模板名+Enter–>/*+Enter
IDEA类和方法注释模板设置相关推荐
- IDEA类和方法注释模板设置(非常详细、实用)
点个赞,看一看,好习惯!本文 GitHub https://github.com/OUYANGSIHAI/JavaInterview 已收录,这是我花了 3 个月总结的一线大厂 Java 面试总结,本 ...
- IntelliJ IDEA 2022 类和方法注释模板设置
一.概述 IDEA自带的注释模板一般都很简单,然而我们在写代码的时候喜欢把类注释和文档注释写在代码里,既方便自己看所有的参数,也便于以后维护代码的时候看到编码作者.下面是我的代码注释,我们就按照这种格 ...
- IDEA方法注释模板设置
IDEA类和方法注释模板设置 1.File–>Settings–>Editor–>Live Templates (1)新建组:命名为userDefine (2)新建模板:选中你刚才创 ...
- idea方法注释模板设置完了,不显示
idea方法注释模板设置完成之后,写了一个方法,但是上面的注释没有自动生成, 此时在方法上面 另起一行, 输入 add(输入add字母就行),然后按下tab键,注释就自动生成了.
- IntelliJ IDEA类和方法注释模板配置
1.设置文件注释 设置Java类的注释模板,创建Java类自动生成该注释模板. 先看文件注释效果: 1.1.选择 IntelliJ IDEA -> 选择 Preferences... 打开IDE ...
- IDEA设置类、方法注释模板
类注释模板 File -> Other Setting -> Default Setting打开默认设置 Editor -> File and Code Templates -> ...
- Idea 设置类、方法注释模板(解决params和return显示问题)---不来虚的 实测有效
目录 1.使用场景 2.操作步骤 2.1.新建类模板注释添加 2.2.给类的方法生成方法注释 3.成果展现 4.参考文章 1.使用场景 我们在开发项目的时候需要知道类的创建者,什么时间创建,这个类是什 ...
- idea设置Java类和方法注释模板
1.创建类/接口时,自动生成注释模板 按照步骤(mac版本):IntelliJ IDEA->Preferences->Editor->File and Code Templates- ...
- IDEA类和方法注释模板
先看效果 类 创建类的时候先描述这个类干啥用的 方法 先说创建类的注释模板 选择class 类注释模板 /** * * @description ${description}* @date ${DAT ...
最新文章
- android overridePendingTransition
- linux的TCP连接数量最大不能超过65535个,那服务器是如何应对百万千万的并发的?
- c语言平均绩点_如何靓化你的GPA
- python图片内容识别_ubuntu 安装 pytesseract 模块进行图片内容识别
- matlab车流量检测,求解释代码,一段交通车流量检测的代码
- Web开发之django(二Admin)
- 拓端tecdat|R语言向量自回归模型(VAR)及其实现
- 242.有效的字母异位词(力扣leetcode) 博主可答疑该问题
- Linux系统基本操作及命令详解
- centos7.4更新安装ssh8.8
- android 远程组件,安卓手机远程协助控制神器 Teamviewer
- iPad 3发布在即,各平板优势大比拼
- 第三章 C语言运算符,表达式,序列点,类型转换
- 用Python分析了30000+《独行月球》影评数据,看看观众们怎么说~
- 计算机应用基础指法实训报告,计算机基础实训报告
- 浏览器输入url后发生的变化
- NKOJ-3776 工资管理
- 前端三剑客 Html Css JavaScript
- 【每日一篇】LinkedList详解
- ubantu报错: 正在等待缓存锁:无法获得锁 /var/lib/dpkg/lock-frontend。锁正由进程3228(aptd)
热门文章
- BUUCTF 2021-10-4 Pwn
- 【CTF资料-0x0002】PWN简易Linux堆利用入门教程by arttnba3
- Qt向MySQL中插入图片
- Shell攻关之运算符
- 程序员面试100题之七 最长公共子字符串
- ping github.com 请求超时/丢包率为100% || Windows “您没有权限在此位置保存文件”(已解决)
- OpenCV基础篇——图形图像旋转
- CentOS Linux基本命令
- 怎么更改计算机用户名网络密码怎么办,怎么改wifi密码和名称(电脑修改wifi密码步骤)...
- Redis——大Key问题