Idea类和方法注释模板设置图文教程-wy
今天为未央给大家带来IDEA注释模板的设置
PDF版教程下载点击下载
- 一. 类注释模板(在创建新的java类时自动添加注释)
首先先看效果图:上面是类注释,下面是方法注释
首先我们来设置类的模板,按照下面的操作点击进入设置
1、 File–>settings–>Editor–>File and Code Templates–>Files
下面解释一些设置的关键字:
(1)${NAME}:设置类名,与下面的${NAME}一样才能获取到创建的类名
(2)TODO:代办事项的标记,一般生成类或方法都需要添加描述
(3)${USER}、${DATE}、${TIME}:设置创建类的用户、创建的日期和时间,这些事IDEA内置的方法,
还有一些其他的方法在绿色框标注的位置,比如你想添加项目名则可以使用${PROJECT_NAME}
下面是我设置的模板,可以直接复制粘贴把名称改了就行:
/**
* @Auther: name
* @Date: ${DATE} ${HOUR}:${MINUTE}
* @Description:
*/
/**
*@创建者: 夜未央
*@创建时间: ${DATE} ${TIME}
*@描述:
*/
在这说明一下有的新建类会有两个注释,请看这里
这样就在创建类就可以了
二 ,方法注释(在方法输入设置的关键字自动生成注释)
附上我的设置代码:
**
*@创建人: 夜未央
*@创建时间: $date$ $time$
*@参数: $params$
*@返回值: $return$
*@描述:
*/
英文版:
**
* @author 用户名
* @date $date$
* @param $params$
* @return $return$
*/
然后点击下面的define进行配置:
配置完成直接一路点击ok就行了,然后测试下
未央的IDEA注释配置教程到这里就结束了,跟着步骤一步步来是不是感觉很简单,如果作者哪里描述有误请加QQ群:523728475 向群主进行反馈。