基于IntelliJ IDEA的类注释和方法注释操作

基于IntelliJ IDEA的类注释和方法注释操作

本文主要介绍基于IntelliJ IDEA的类注释和方法注释操作,有很好的参考价值,希望对大家有所帮助。来和边肖一起看看吧。

效果图如下:

类注释:

方法注释:

Idea不会默认为我们设置,需要手动设置。

1:在1:IDEA中,创建类时会自动添加注释。

打开idea,操作

文件-设置-编辑器-文件和代码模板-文件

(1)名称:设置类名,与下面的名称相同:创建的类名可以像下面的{NAME}一样获得。

(2)TODO:代理事项的标记。一般需要描述生成类或方法。

(3)USER,USER,{DATE},TIME:设置创建该类的用户,创建的日期和时间。这些东西是IDEA内置的方法,其他一些方法标在红框里。比如要添加一个项目名,可以用time:设置创建该类的用户,创建的日期和时间,这些东西都是IDEA内置的方法,还有一些其他的方法用红框标出。例如,如果要添加项目名称,可以使用time。

2.在方法的上一行输入/*并按回车键,方法的注释将设置如下

IDEA不够智能,无法自动为我们创建方法注释,这意味着我们需要手动为方法添加注释。当使用Eclipse时,我们生成注释的习惯是

/**回车,这里我们也按照这个习惯设置IDEA的方法注释。

1、FileSettingsEditorLive Templates

(1)新建组:命名为userDefine

(2)选中userDefine在其目录下新建模板:命名为*

因为IDEA生成注释的默认方式是:/*模板名称快捷键(例如,如果模板名称设置为添加快捷键并且使用了Tab,则生成方式是

/*add Tab),如果不采用这种生成方法,IDEA中没有内容的方法将不可用,比如获取方法参数的methodParameters()和获取方法返回值的methodReturnType()。

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

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

注意第一行,只有一个代替/

在设置参数名时,必须使用参数名的方法,否则无法读取在步骤5中设置的参数名。

*

* @作者小思

* @Description //TODO

* @Date $time$ $date$

* @Param $param$

* @return $return$

**/

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

单击模板页面底部的警告,设置要应用于这些场景的模板。一般可以选择EveryWhere-Java(如果已经修改,会显示为change而不是define)。

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

从下拉列表中选择。

注意第5步和第6步的顺序不能颠倒~

以上基于IntelliJ IDEA的类注释和方法注释操作都是边肖分享的内容。希望给大家一个参考,支持我们。

基于IntelliJ IDEA的类注释和方法注释操作