欢迎您访问程序员文章站本站旨在为大家提供分享程序员计算机编程知识!
您现在的位置是: 首页

Eclipse或STS设置Java代码注释模板

程序员文章站 2022-06-01 12:30:37
...

设置注释模板的入口: Window->Preference->Java->Code Style->Code Template 然后展开Comments节点就是所有需设置注释的元素啦。现就每一个元素逐一介绍,我只记录了一些常用的:

文件 (Files)注释标签:

/**  
 * @Title: ${file_name}
 * @Package ${package_name}
 * @Description: ${todo}
 * @author yokoboy
 * @date ${date}
 */

类型 (Types)注释标签(类的注释):

/**
 * ClassName: ${type_name} 
 * @Description: ${todo}
 * @author yokoboy
 * @date ${date}
 */

字段 (Fields)注释标签:

/**
 * @Fields ${field} : ${todo}
 */

构造函数标签:

/**
 * <p>Description: </p>
 * ${tags}
 */

方法 (Constructor & Methods)标签:

/**
 * @Description: ${todo}
 * @param ${tags}   
 * @return ${return_type}  
 * @throws
 * @author yokoboy
 * @date ${date}
 */