IDEA类和方法注释模板设置(非常详细)

IDEA自带的注释模板不是太好用,我本人到网上搜集了很多资料系统的整理了一下制作了一份比较完整的模板来分享给大家,我不是专业玩博客的,写这篇文章只是为了让大家省事。

这里设置的注释模板采用Eclipse的格式,下面先贴出Eclipse的注释模板,我们就按照这种格式来设置:

类注释模板:                                                                      方法注释模板:

     

一、首先我们来设置IDEA中类的模板:(IDEA中在创建类时会自动给添加注释)

1、File-->settings-->Editor-->File and Code Templates-->Files

我们选择Class文件(当然你要设置接口的还也可以选择Interface文件)

(1)${NAME}:设置类名,与下面的${NAME}一样才能获取到创建的类名

(2)TODO:代办事项的标记,一般生成类或方法都需要添加描述

(3)${USER}、${DATE}、${TIME}:设置创建类的用户、创建的日期和时间,这些事IDEA内置的方法,还有一些其他的方法在绿色框标注的位置,比如你想添加项目名则可以使用${PROJECT_NAME}

(4)1.0:设置版本号,一般新创建的类都是1.0版本,这里写死就可以了

提供可复制的模板

  1. /**
  2. *@ClassName ${NAME}
  3. *@Description TODO
  4. *@Author zenghw
  5. *@Date ${DATE} ${TIME}
  6. */

创建类时,有可能会出现这个:

解决方案:

  • file 》 settings》File and Code Templates
  • 中间的,选择 includes ,选中File Header。
  • 清空,保存更新。

2、效果图展示

二、设置方法注释模板

IDEA还没有智能到自动为我们创建方法注释,这就是要我们手动为方法添加注释,使用Eclipse时我们生成注释的习惯是

/**+Enter,这里我们也按照这种习惯来设置IDEA的方法注释

1、File-->Settings-->Editor-->Live Templates

(1)新建组:命名为userDefine

(2)新建模板:命名为*

因为IDEA生成注释的默认方式是:/*+模板名+快捷键(比如若设置模板名为add快捷键用Tab,则生成方式为

/*add+Tab),如果不采用这样的生成方式IDEA中没有内容的方法将不可用,例如获取方法参数的methodParameters()、

获取方法返回值的methodReturnType()

(3)设置生成注释的快捷键

(4)设置模板:模板内容如下

注意第一行,只有一个*而不是/*

在设置参数名时必须用${参数名}$的方式,否则第五步中读取不到你设置的参数名

如果使用/*生成的模板注释将会是如下效果:所以我们要去掉最前面的/*

可复制模板:

  1. *
  2. * @Description //TODO
  3. * @Date $date$ $time$
  4. * @param $param$
  5. *@return $return$
  6. **/

(5)设置模板的应用场景

点击模板页面最下方的警告,来设置将模板应用于那些场景,一般选择EveryWhere-->Java即可

(如果曾经修改过,则显示为change而不是define)

(6)设置参数的获取方式

选择右侧的Edit variables按钮

PS:第五步和第六步顺序不可颠倒,否则第六步将获取不到方法

选择每个参数对应的获取方法(在下拉选择框中选择即可)

多参数时要用脚本来处理,复制下面这段代码到上面的位置

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())

(7)效果图

创建方法,在方法上面操作:-->/**+Enter

转载于:https://blog.csdn.net/xiaoliulang0324/article/details/79030752

原文地址:https://www.cnblogs.com/wang3680/p/12394053.html

时间: 2024-10-09 21:45:47

IDEA类和方法注释模板设置(非常详细)的相关文章

IDEA类和方法注释模板设置

在开发中使用idea的注释总结:由于IDEA自带的注释模板不是太好用,所以整理一下适用于自己的模板: 一.首先我们来设置IDEA中类的模板:(IDEA中在创建类时会自动给添加注释) 1.File-->settings-->Editor-->File and Code Templates-->Files 我们选择Class文件(当然你要设置接口的还也可以选择Interface文件) (1)${NAME}:设置类名,与下面的${NAME}一样才能获取到创建的类名 (2)<p>

IDEA设置类、方法注释模板

类注释模板 File -> Other Setting -> Default Setting打开默认设置 Editor -> File and Code Templates -> Files -> Class 找到类注释模板,在public class前面添加模板注释 /** * @program: ${PROJECT_NAME}->${NAME} * @description: ${description} * @author: qiuyu * @create: ${

Zend studio文件注释模板设置方法

步骤:Window -> PHP -> Editor -> Templates,这里可以设置(增.删.改.导入等)管理你的模板.新建文件注释.函数注释.代码块等模板的实例 新建模板,分别输入Name.Description.Pattern a)文件注释 Name: 3cfileDescription: tkyouxi.com文件注释模板 Pattern:/*** tkyouxi.com xx文件* =============================================

IntelliJ IDEA 注释模板设置

1.idea类注释 打开:file->setting->Editor->Filr and Code Templates->Includes->File Header 类注释模板: 按 Ctrl+C 复制代码 按 Ctrl+C 复制代码 2.方法注释 打开file->setting->Editor->LiveTemplates点击右边上面那个绿色的+号,选择Template Group双击,然后弹出一个窗口,随便添加一个名字,我这里添加的是MyGroup然后点

&quot;佛祖保佑 永无bug&quot; 注释模板设置详解(仅供娱乐)

1.注释模板效果图 今天在网上看到一段有趣的注释,佛祖保佑 永无bug, 效果如下图所示:  代码如下所示: /** * _ooOoo_ * o8888888o * 88" . "88 * (| -_- |) * O\ = /O * ____/`---'\____ * .' \\| |// `. * / \\||| : |||// * / _||||| -:- |||||- * | | \\\ - /// | | * | \_| ''\---/'' | | * \ .-\__ `-`

【转载】 Eclipse注释模板设置详解

 Eclipse注释模板设置详解 网站推荐: 金丝燕网(主要内容是 Java 相关) 木秀林网(主要内容是消息队列)

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 $

Eclipse最新版注释模板设置详解

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

Eclipse Java注释模板设置详解

网上的Eclipse注释模板,在这里稍稍整理一些比较常用的. 编辑注释模板的方法:Window->Preference->Java->Code Style->Code Template 然后展开Comments节点就是所有需设置注释的元素啦.现就每一个元素逐一介绍: 1.文件(Files)注释标签: /** * All rights Reserved, Designed By www.tydic.com * @Title: ${file_name} * @Package ${pac