IDEA中设置注释模板的方法

IDEA中设置注释模板主要分为两个部分,分别是创建java文件时类的注释和方法的注释。

  这里为大家详细介绍一下方法,按MyEclipse的风格设置(MyEclipse的请看:MyEclipse中设置注释模板的方法),大家可以根据自己的习惯生成自己喜欢的注释模板。效果如下:

一、设置类的注释模板

1、选择File→Settings→Editor→File and Code Templates→Files→Class。可以看到创建Class时引入了一个参数"File Header.java"。对应的是Files旁边的Includes→File Header文件。

2、File Header里就是创建类时的注释模板,下面Description中有描述一些可以配置的参数,可以根据自己需要选用。

二、设置方法的注释模板

1、选择File→Settings→Editor→Live Templates。点击右边的加号,选择Template Group,创建一个分组。

2、再点击加号,选择Live Template,创建一个模板。其中:

Abbreviation:填模板的缩写,可以使用*号作为代号,方便后面调用模板。

Options→Expand with:填注释模板的扩展快捷键,根据使用习惯,这里使用默认的Tab。

Template text:填写注释模板的内容。参数名使用${参数名}$的格式。(注意:注释模板开头的/不要填写,原因可以看文章末尾的解释)


3、点击模板页面最下方的警告define,来设置将模板应用于哪些场景,选择Everywhere-->Java即可。(如果曾经修改过,则显示为change而不是define,如上图)

4、然后点击Edit variables,会读取刚刚在注释模板中的配置的参数${参数名}$。在Expression的下拉框中选择方法为其赋值。

5、参数赋值优化

(1)如果param参数使用默认的methodParameters()来获取方法参数值,其注释参数是在一行展示的,如下图。这里我们希望像MyEclipse中一样,一行一个参数的样式,可以通过脚本来实现。将以下脚本复制进Expression,可以得到文章开头效果图的样式:

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

(2)如果return参数使用默认的methodReturnType()来获取参数值,模板里使用了@link来跳转结果类型,那么当方法返回值为void时,注释会报错,如下图。可以通过脚本来避免,将上面模板中的@link参数去掉,将以下脚本复制进Expression:

groovyScript("def result=\"${_1}\"; if(result == \"void\"){return \"\";}else{return \"{@link \"+result+\"}\";}", methodReturnType())

6、注释模板的调用。通过输入 / + * + Tab键,即先输 /* 再按Tab键,就可以调用模板。因为刚刚我们把*被设置为模板的代号,Tab键设置为模板的扩展快捷键,也可以把Tab改为Enter键,更加还原MyEclipse。

PS:(1)注意,注释模板开头不要使用/,因为设置后虽然可以更便捷的使用 * + Tab键,调用模板。但是会存在param为null的情况(原因暂时未知),如下图,需要在方法内调用才能获取参数,但这样还需要将注释复制到方法外反而使用不便。

(2)注释模板中的user参数是获取系统的用户(当然注释作者也可以直接写固定值,但是配置更有意思,哈哈),经常不是自己需要的作者名,可以在IDEA中进行配置。打开→IDEA的安装目录\bin\idea64.exe.vmoptions。在最下面增加一行-Duser.name=username。

其中username就是你希望为user参数的赋值。

原文地址:https://www.cnblogs.com/liuminchao/p/12638513.html

时间: 2024-10-13 09:47:54

IDEA中设置注释模板的方法的相关文章

eclipse 中设置注释模板

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

[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

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

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

css网页中设置背景图片的方法详解

css网页中设置背景图片的方法详解 在css代码中设置背景图片的方法,包括背景图片.背景重复.背景固定.背景定位等 用css设置网页中的背景图片,主要有如下几个属性: 1,背景颜色 {background-color:数值}2,背景图片 {background-image: url(URL)|none}3,背景重复 {background-repeat:inherit|no-repeat|repeat|repeat-x|repeat-y}4,背景固定 {background-attachment

asp中设置session过期时间方法总结

http://www.jb51.net/article/31217.htm asp中设置session过期时间方法总结 作者: 字体:[增加 减小] 类型:转载 asp中默认session过期时间为20分钟,很多情况下不够,今天有客户要求很多就要重新登录了,所以准备了这篇文章,方便需要的朋友 如果程序中没有设置session的过期时间,那么session过期时间就会按照IIS设置的过期时间来执行,IIS中session默认过期时间为20分钟,IIS中session时间可以更改 时间设置要放在前面

MyEclipse设置注释模板

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

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

Android中设置全屏的方法

在实际的应用程序开发中,我们有时需要把 Activity 设置成全屏显示,一般情况下,可以通过两种方式来设置全屏显示效果.其一,通过在代码中可以设置,其二,通过manifest配置文件来设置全屏. 其一:在代码中设置(如下) public void onCreate(Bundle savedInstanceState) { super.onCreate(savedInstanceState); //设置无标题 requestWindowFeature(Window.FEATURE_NO_TITL

Eclipse中设置注释、日期等信息

在使用Eclipse 编写Java代码时,自动生成的注释信息都是按照预先设置好的格式生成的,例如其中author,datetime等属性值. 我们可以在Eclipse 中进行设置自己希望显示的注释信息. 操作如下:点击Windows->Preferences->Java->Code Style->Code Templates, 在右边有个的comments选项, 我们就可以在里面编辑相关的注释信息. 例如我们希望在一个Java文件的开头设置作者作者信息以及日期信息. 选择Types