首页 > 编程知识 正文

idea怎么生成注释,idea修改注释模板

时间:2023-05-05 14:44:37 阅读:23236 作者:3699

IDEA评论模板设置1,类评论

打开IDEA的Settings,单击Editor--File and Code Templates,然后单击右侧的File选项卡下的Class,将图中红框内的内容添加到其中。

/** * @author author * @date ${YEAR}年${MONTH}月${DAY}日${TIME} */

我提供的示例模板说明了作者和时间。 IDEA支持的所有模板参数都列在下面的说明中。

保存后,在创建新类时,舒适的爆米花会自动添加类注释。 如果还想启用接口,请同时配置上图中的接口项。

二、方法评论不同于目前网络上互相复制粘贴的方法注释教程,本文将实现以下功能:

根据自动生成方法是否具有返回值从表单参数条目智能生成@param注释的@Return注释与类模板相比,在方法中添加注释模板更复杂。 首先,在Settings中单击编辑器--live templates。

单击最右边的,首先选择2. Template Group .以创建模板组。

在弹出的对话框中填写组名。 这里称为用户定义:

然后选择刚创建的模板组userDefine,单击,然后选择1. Live Template。

将创建空模板,并修改该模板的Abbreviation、Description和Template text。 需要注意的是,Abbreviation必须为*,最后检查扩展宽度的值是否为Enter键。

上图的 Template text的内容如下,请直接复制。 http://www.Sina.com/http://www.Sina.com /

* * @ authorjitwxs * @您注意到date $ date $ time $ $ param $ $ return $ * /右下角的No applicable contexts yet了吗? 此时,表示此模板没有指定要应用的语言:

单击Define并在组合框中选中Java,以指示该模板将应用于所有Java类型文件。

设置应用程序上下文

请记住,在配置Template text时包含类似$date$的参数。 此时,IDEA不知道这些参数是什么。 然后,对这些参数进行方法映射,以便IDEA理解这些参数的含义。 单击Edit variables按钮。

设置与每个参数对应的表达式。

表达式设置

需要注意的是,date和time expression使用IDEA中的内置函数,因此直接在下拉框中选择即可,但名为param的参数IDEA的缺省实现较差,需要手动实现代码如下。

goovyscript('defresult=' ' ); def params=' $ { _1}'.replace all (((((()|(\s )、() ) ) )、()、()、)、) i params.size (; I(if ) Params[I]!=' ' ) result=' * @ param ' params [ I ] ((iparams.size (-1 ) ) )。 rn':'}; 返回结果=='? null : '\r\n ' result ',methodParameters () )此外,还自己实现了名为return的参数。 代码如下。

goovyscript (' return' $ { _1}"=' void '? null3360'rn*@return''${_1}',methodReturnType ()注意到未检查Skip if defined属性。 这个属性已被选中,因为如果正在生成,我就不需要这个功能。

点击OK保存设定,取得巨大成功!

三、检测成果3.1类注释类注释只能在需要注意首行没有,效果如下:

3.2方法注释说明了以下情况:

无形参照单一参照多重参照无返回值有返回值

四. QA http://www.Sina.com/http://www.Sina.com /

由于IDEA模板生成逻辑是模板名称生成键,因此如果生成键为Enter,则可以输入* Enter启动模板。

这也说明了评论模板的第一行为*的原因。 因为如果首先输入/*,然后输入* Enter来触发模板,则第一行正好拼写为/**,并且符合Javadoc规范。

http://www.Sina.com/http://www.Sina.com /

答:因为我习惯在这一行写方法说明,所以我保留了一行空白留言。 你也可以删除那个。

http://www.Sina.com/http://www.Sina.com /

a )首先,internet上提供的大多数列生成函数在没有参数的情况下生成空@param,因此请修改列函数的代码,以避免在没有参数的情况下生成@param。 但是,为此需要$param$与其他人在同一行。 否则,无法处理后退。

http://www.Sina.com/http://www.Sina.com /

a )方法返回类型) )在没有返回值时返回void。 因为这没有什么意义,所以我们处理了方法返回类型)的返回值。 仅在有返回值时生成。

http://www.Sina.com/http://www.Sina.com /

a )方法返回null )时,无法解决失败问题。 理由与第三个相同。

版权声明:该文观点仅代表作者本人。处理文章:请发送邮件至 三1五14八八95#扣扣.com 举报,一经查实,本站将立刻删除。