java类注释和方法注释(idea配置类注释)

内容广告上

IDEA自己的标注模板不是很好用。我个人在网上搜集了很多资料,系统整理了一下,做了一个比较完整的模板和大家分享。我不是专业的博主。我写这篇文章只是为了给你省去麻烦。

这里的注释模板集是Eclipse格式的。Eclipse的注释模板将发布在下面,我们将按照以下格式进行设置:

类别注释模板:

方法注释模板:

首先,让我们在IDEA中设置类的模板:(在IDEA中,类将被自动注释)

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

我们选择Class文件(当然,如果要设置接口,也可以选择Interface文件)

(1)${NAME}:设置类名,就像下面的${NAME}一样,获取创建的类名。

(2)TODO:自己动手项目的标签。通常,需要描述生成的类或方法。

(3)${USER}、${DATE}、${TIME}:设置创建类的用户、创建的日期和时间,这些东西都是IDEA的内置方法,还有一些方法是用绿框标注的。例如,如果要添加项目名称,可以使用${PROJECT_NAME}。

(4)1.0:设置版本号。一般来说,新创建的类是1.0版本,所以在这里写死它就行了。

2.呈现效果图

第二,设置方法注释模板

IDEA不够聪明,不能自动为我们创建方法注释,这意味着我们必须手动为方法添加注释。使用Eclipse时,我们生成注释的习惯是

/**进入,这里我们也根据这个习惯设置IDEA的方法标注。

1、文件-设置-编辑器-实时模板

(1)创建一个新组:命名为用户定义。

(2)创建新模板:命名它*

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

/*添加Tab),如果不采用这种生成方法,IDEA中没有内容的方法将不可用,比如获取方法参数的methodParameters(),

获取方法返回值的methodReturnType()。

(3)设置生成评论的快捷键。

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

注意第一行,只有一个*而不是/*

设置参数名时,必须使用$ {parameter name} $,否则无法读取第五步设置的参数名。

* * @作者chengpunan * @ Description//TODO $ end $ * @ Date $ time $ $ Date $ * @ Param $ Param $ * @ return $ return $ * */

如果您使用/*来生成模板注释,它将具有以下效果:因此我们需要删除前面的/*

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

单击模板页面底部的警告,设置模板将应用于哪些场景。一般选择EveryWhere - Java。

(如果已被修改,将显示为更改而不是定义)

(6)设置参数的采集方式。

选择右侧的编辑变量按钮。

PS:第五步和第六步的顺序不能颠倒,否则第六步得不到方法。

选择每个参数对应的采集方式(只需在下拉选择框中选择即可)。网上有很多关于获取参数时如何使用脚本的教程。我尝试过使用脚本。

的方法不仅麻烦,而且只能在方法内部使用注释时获取参数。

(7)效果图

创建一个方法,并在方法上写入:/*模板名称输入-/* *输入。

内容广告下