目录
IDEA配置类注释模板
打开 IDEA 的 Settings
,点击 Editor-->File and Code Templates
,点击右边 File
选项卡,在下面找到的 Class
,将注释模板配置到图中红框内后,点击Apply按钮,而后点击OK按钮,即可完成类注释配置
类注释示例模板如下:
/**
* @ClassName:${NAME}
* @Author: ${USER}
* @Date: ${DATE} ${TIME}
* @Description: 必须描述类做什么事情,实现什么功能
*/
本文提供的示例模板中,说明了类名称、作者、时间和类描述,IDEA 支持的所有的模板参数在下方的 Description
中被列出,如下图
保存后,当你创建一个新的类的时候就会自动添加类注释。如果你想对接口也生效,按照上述配置,配置Files选项卡中的Interface
项即可
IDEA配置方法注释模板
相较于类模板,为方法添加注释模板就较为复杂,
首先在 Settings
中点击 Editor-->Live Templates
。
点击上方的 +
,首先选择 2.Template Group...
来创建一个模板分组,如图
创建Template
分组
在弹出的对话框中填写分组名,本文创建的示例分组名为 JavaMethod