关于工具:idea添加注释模板

31次阅读

共计 1696 个字符,预计需要花费 5 分钟才能阅读完成。

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 版本,这里写死就能够了

2. 效果图展现

二、设置办法正文模板

IDEA 还没有智能到主动为咱们创立办法正文,这就是要咱们手动为办法增加正文,应用 Eclipse 时咱们生成正文的习惯是 /**+Enter,这里咱们也依照这种习惯来设置 IDEA 的办法正文

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

(1)新建组:命名为 userDefine

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

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

/*add+Tab),如果不采纳这样的生成形式 IDEA 中没有内容的办法将不可用,例如获取办法参数的 methodParameters()、获取办法返回值的 methodReturnType()
![效果图]
<img alt=”” class=”has” src=”https://img-blog.csdn.net/20180111101620220?watermark/2/text/aHR0cDovL2Jsb2cuY3Nkbi5uZXQveGlhb2xpdWxhbmcwMzI0/font/5a6L5L2T/fontsize/400/fill/I0JBQkFCMA==/dissolve/70/gravity/SouthEast”>

(3)设置生成正文的快捷键
![效果图]
<img alt=”” class=”has” src=”https://img-blog.csdn.net/20180111102440886?watermark/2/text/aHR0cDovL2Jsb2cuY3Nkbi5uZXQveGlhb2xpdWxhbmcwMzI0/font/5a6L5L2T/fontsize/400/fill/I0JBQkFCMA==/dissolve/70/gravity/SouthEast”>

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

留神第一行,只有一个 而不是 /

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

留神:上面这段是代码,能够间接复制的!能够间接复制的!能够间接复制的!不要再问我为什么都是图片了,留着眼睛干啥?

如果应用 /生成的模板正文将会是如下成果:所以咱们要去掉最后面的 /

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

点击模板页面最下方的正告,来设置将模板利用于那些场景,个别抉择 EveryWhere–>Java 即可

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

6)设置参数的获取形式

抉择右侧的 Edit variables 按钮

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

抉择每个参数对应的获取办法(在下拉抉择框中抉择即可),网上有很多教程说获取 param 时应用脚本的形式,我试过应用脚本

的形式不仅麻烦而且只能在办法外部应用正文时能力获取到参数

(7)效果图

创立办法,在办法下面写:/+ 模板名 +Enter–>/*+Enter

正文完
 0