首页 > 代码库 > MyEclipse，Eclipse注释规范模板
MyEclipse，Eclipse注释规范模板
注释的作用：myeclipse中java文件头注释格式设置，最终可用于javadoc.exe生成API文档，同时提高了代码的可读性
设置方法：
windows->preferences->java->Code Style->Code Templates->comments->Type->edit
Files 新建类文件
/*** @Title: ${file_name}
* @Package ${package_name}
* @Description: ${todo}(用一句话描述该文件做什么)
* @author : ${user}
* @date : ${date} ${time}
* @version V1.0
*/
Types 类型文件
/**
* Copyright (c) 2017 by [个人或者公司信息]
* @ClassName: ${file_name}
* @Description: ${todo}(用一句话描述该文件做什么)
*
* @author: ${user}
* @version: V1.0
* @Date: ${date} ${time}
*/
字段(Fields)注释标签：
/**
* @Fields ${field} : ${todo}(用一句话描述这个变量表示什么)
*/
构造函数标签：
/**
* <p>Title: </p>
* <p>Description: </p>
* ${tags}
*/
方法(Constructor & Methods)标签：
/**
* @Title: ${enclosing_method}
* @Description: ${todo}(这里用一句话描述这个方法的作用)
* @param ${tags} 设定文件
* @return ${return_type} 返回类型
* @throws
*/
覆盖方法(Overriding Methods)标签：
/* (非 Javadoc)
* <p>Title: ${enclosing_method}</p>
* <p>Description: </p>
* ${tags}
* ${see_to_overridden}
*/
代表方法(Delegate Methods)标签：
/**
* ${tags}
* ${see_to_target}
*/
getter方法标签：
/**
* @return ${bare_field_name}
*/
setter方法标签：
/**
* @param ${param} 要设置的 ${bare_field_name}
*/
MyEclipse，Eclipse注释规范模板
声明：以上内容来自用户投稿及互联网公开渠道收集整理发布，本网站不拥有所有权，未作人工编辑处理，也不承担相关法律责任，若内容有误或涉及侵权可进行投诉： 投诉/举报 工作人员会在5个工作日内联系你，一经查实，本站将立刻删除涉嫌侵权内容。