geany中tab设置_IDEA 2019.1 类和方法注释模板设置

IDEA类和方法注释模板设置

作者:wRitchie来源:http://bj9420.com

IDEA自带的注释模板不是太好用,整理了一下制作了一份比较完整的模板,这里设置的注释模板采用Eclipse的格式,下面先贴出Eclipse的注释模板,我们就按照这种格式来设置:

类注释模板:

2991f24d7e6727a9f4d7319d97ceb5ee.png

方法注释模板:

7bf3b2cb6f8cef963f66ab0fab8db555.png

一、首先我们来设置IDEA中类的模板:

设置类注释模板

1.选择File–>Settings–>Editor–>File and Code Templates–>Includes–>File Header.

88f0ee495b0e2c19bb4f6d54bcf90a95.png

2、效果图展示

322f2fc97cff775806fc8d96dca3f42e.png

二、设置方法注释模板

IDEA没有智能到自动创建方法注释,需手动为方法添加注释,使用Eclipse时我们生成注释的习惯是/**+Enter,也按照这种习惯来设置IDEA的方法注释

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

d2a5249ffc0a6a55e4b80870ff4c9517.png

(1)新建组:命名为wRitchie

cdd0fc84339a218b030e71ee0efb8958.png

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

82507e1dae7416de6c5aeaeef4ce404a.png
c6179459681e2f585a99b0eef980c504.png

注:因为IDEA生成注释的默认方式是:/*+模板名+快捷键(例:若设置模板名为add,快捷键用Tab,则生成方式为/*add+Tab)若不采用这样的生成方式,IDEA中没有内容的方法将不可用,例如:获取方法参数的methodParameters()、获取方法返回值的methodReturnType()

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

88233ce9c286bf4e60fd5a0c376d1d4a.png

(4)设置模板

模板内容如下,注意第一行,只有一个"*"而不是"/*",在设置参数名时必须用:${参数名}$的方式,否则第五步中读取不到你设置的参数名

*

* @Author: wRitchie

* @Description: $description$

* @Param: $params$

* @return: $returns$

* @Date: $date$ $time$

*/

若使用/*生成的模板注释,效果如下,所以需去掉最前面的/*

d4114a5ec685d8c0012da82c130ce901.png

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

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

21915ecd13458d75c88b0b7d8f3ac1a8.png

若已定义过,则显示修改,好为change而不是define,如下图

37e8e21fc8012632c7a14052c7c896f0.png
3c044065de30447992dc9fb9cb2daeee.png

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

选择右侧的Edit variables按钮

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

0b9b0b2f84b9faa11414d4f7b94b7677.png

选择每个参数对应的获取方法(在下拉选择框中选择即可),网上有很多说获取param时使用脚本的方式,试过使用脚本的方式不仅麻烦,而且只能在方法内部使用注释时才能获取到参数。

ab93a89fde8057b96edd5dbfb3dc2c43.png

(7)效果图

创建方法,在方法上面写:/**+Enter

/**

*@Author:wRitchie

*@Description:

*@Param:[userId, password]

*@return:java.lang.String

*@Date:2018/11/27 16:42

*/


版权声明:本文为weixin_39888807原创文章,遵循CC 4.0 BY-SA版权协议,转载请附上原文出处链接和本声明。