在用idea写Java工程代码的时候,需要让idea自动生成一些重复性注释,这个我们可以通过设定模板的方式来进行设置。
类注释模板的设定
位置选择
1、Preferences ——> File and Code Templates ——> Includes里添加File Header模板
模板内容设定
直接将下面代码拷贝到模板内容里面即可,当然也可以按照自己的需求进行更改:
/**
* @author YourName
* @project ${PROJECT_NAME}
* @company YourCompanyName
* @version
* @date ${TIME} ${DATE}
* @class ${NAME}
* @brief
*/
- 注意事项
模板下面有一个Enable Live Templates
选项需要进行勾选,否则方法模板设置对应的的Live Templates
选项找不到。
-效果展示
直接创建一个类后,即可有类模板的自动注释,版本信息及简介内容可以自己手动填入:
方法模板的设定
- 位置选择
1、Preferences ——> Live Templates ——>添加用户自定义模板
2、模板命名&&模板描述&&快捷键设定
可以命名为*
,这样方面键入快速注释,添加模板描述信息,例如:add Commands for method
,然后设定快捷键可以为Enter
键。 - 模板内容设定
1、Template text 内容:
**
* @author YourName
* @date $time$ $date$
* @method $name$
* @brief
* @Param $param$
* @return $return$
*/
2、Edit variables 编辑变量内容:
直接编辑Expression
一列各个对应的内容,进行选择设定内容即可。
- 效果展示
键入/*
,然后按入回车键(Enter)
,即可快速添加模板注释内容,效果如下: