IDEA中Java类和方法注释

一:类注释

File-->Settings-->Editor-->File and CodeTemplates

/**
 * Created with IntelliJ IDEA.
 * Copyright@ Apache Open Source Organization
 * @Auther: Apache
 * @Date: ${YEAR}/${MONTH}/${DAY}/${TIME}
 * @Description: 
 */

二:方法注释:

1. File-->Settings-->Editor-->Live Templates

 2.  点击右上角的绿色+号,然后选择Template Group,然后输入group的name,我这里输入:MyGroup,然后点ok

3. 选中刚才创建的MyGroup,然后再次点击右侧的绿色+,这次选择的是第一个Live Template。取名为 *,名字可以根据个人习惯取

4. 配置模板,模板开头是*而不是/*,@Param:后边必须跟冒号(:),否则@Param这个参数上就报错,这是关键所在

/*
 * @Description:
 * @Author: Apache
 * @Date:   $DATE$ $TIME$
 * @Param:  $PARAMS$
 * @Return: $RETURN$
 */

注意:只有当变量被$$包围时右侧的Edit variables才可以点击

5. 编辑好模板之后就为参数添加变量,点击右侧的 Editor variables配置变量,点击ok,然后点击模板下方的Change,打开界面根据需要选择要生成注释的文件

对应的变量值:

Date              date()
TIME              time()
PARAMS        methodParameters()
RETURN         methodReturnType()

 

6. 完成之后点击Apply,然后点击OK,注意了,重点的地方,在你的方法上输入 /**,这就是我为什么不取字母而取名为*,因为这样很快速,再按Eneter键就会出现你想要的注释了,这种方法可以获取到@param和@return。效果如下:

/**
 * @Description: 
 * @Author: Apache
 * @Date: 2018/3/20 17:26
 * @Param: [name, sex, age]
 * @Return: java.util.List<?>
*/
public List<?> AddStuInfo(String name, String sex, int age){
    List list = new ArrayList();
    list.add(name);
    list.add(sex);
    list.add(age);
    return list;
}
发布了91 篇原创文章 · 获赞 79 · 访问量 63万+

猜你喜欢

转载自blog.csdn.net/yexiaomodemo/article/details/103040114