一、类注释
打开 IDEA 的 Settings
,点击 Editor-->File and Code Templates
,点击右边 File
选项卡下面的 Class
,在其中添加图中红框内的内容:
/**
* @author jitwxs
* @date ${YEAR}年${MONTH}月${DAY}日 ${TIME}
*/
在我提供的示例模板中,说明了作者和时间,IDEA 支持的所有的模板参数在下方的 Description
中被列出来。
保存后,当你创建一个新的类的时候就会自动添加类注释。如果你想对接口也生效,同时配置上图中的 Interface
项即可。
二、方法注释
不同于目前网络上互相复制粘贴的方法注释教程,本文将实现以下功能:
-
根据形参数目自动生成
@param
注解 -
根据方法是否有返回值智能生成
@Return
注解
相较于类模板,为方法添加注释模板就较为复杂,首先在 Settings
中点击 Editor-->Live Templates
。
点击最右边的 +
,首先选择 2. Template Group...
来创建一个模板分组:
在弹出的对话框中填写分组名,我这里叫做 userDefine: