网上的Eclipse注释模板,在这里稍稍整理一些比较常用的。
编辑注释模板的方法:Window->Preference->Java->Code Style->Code Template 然后展开Comments节点就是所有需设置注释的元素啦。现就每一个元素逐一介绍:
1.文件(Files)注释标签:
/**
* @Description: ${todo}(用一句话描述该文件做什么)
* @Title: ${file_name}
* @Package ${package_name}
* @author: 佳云科技有限责任公司:XXX
* @date: ${date} ${time}
* @version V1.0
* 注意:本内容仅限于武汉佳云科技有限责任公司内部传阅,禁止外泄以及用于其他的商业目
* @Copyright: ${year} www.jiayunkeji.com Inc. All rights reserved.
* All rights Reserved, Designed By www.jiayunkeji.com
*/
2.类型(Types)注释标签(类的注释):
/**
* @Description:${todo}(这里用一句话描述这个类的作用)
* @ClassName: ${type_name}
* @author: 佳云科技有限责任公司:XXX
* @date: ${date} ${time}
* ${tags}
* 注意:本内容仅限于武汉佳云科技有限责任公司内部传阅,禁止外泄以及用于其他的商业目
* @Copyright: ${year} www.jiayunkeji.com Inc. All rights reserved.
*/
3.字段(Fields)注释标签:
/**
* @Fields ${field} : ${todo}(用一句话描述这个变量表示什么)
*/
4.构造函数标签:
/**
* @Title: ${enclosing_type}
* @Description: ${todo}(这里用一句话描述这个方法的作用)
* @param: ${tags}
* @throws
*/
5.方法(Methods)标签:
/**
* @Description: ${todo}(这里用一句话描述这个方法的作用)
* @Title: ${enclosing_method}
* @param: ${tags}
* @return: ${return_type}
* @throws
* @date: ${date} ${time}
*/
6.覆盖方法(Overriding Methods)标签:
/**
* <p>Title: ${enclosing_method}</p>
* <p>Description: </p>
* ${tags}
* ${see_to_overridden}
*/
7.代表方法(Delegate Methods)标签:
/**
* ${tags}
* ${see_to_target}
*/
8.getter方法标签:
/**
* @Title: ${enclosing_method} <BR>
* @Description: please write your description <BR>
* @return: ${field_type} <BR>
*/
9.setter方法标签:
/**
* @Title: ${enclosing_method} <BR>
* @Description: please write your description <BR>
* @return: ${field_type} <BR>
*/
相关推荐
在Eclipse这一强大的集成开发环境(IDE)中,设置自动生成注释的功能是提升编码效率、维护代码可读性及专业性的有效手段。对于初学者乃至资深开发者而言,掌握如何在创建新类时自动添加注释,不仅能节省时间,还能...
- 在右侧的“Code Generation”区域可以看到默认的类注释模板。 - 点击编辑框内的文本进行修改。 3. **添加必要的信息**: - 按照给定的模板样例,我们可以添加以下信息: - 工程文件路径:`${PROJECT_NAME}/${...
- **方法注释快捷键**:IDEs如Eclipse或IntelliJ IDEA提供了注释生成快捷键,如`/**`+回车键,自动插入方法的Javadoc模板,便于快速添加注释。 #### 四、代码组织策略 - **变量排序**:按照访问级别从高到低排序,...
#### 四、版权与免责声明 - **内容归属**:所有内容和图形均为 tutorialspoint.com 的财产。 - **分发限制**:未经书面许可,不得以任何形式重制或分发内容。 - **准确性声明**:tutorialspoint.com 不保证内容的...
- 每个文件顶部都应包含文件的功能描述、作者信息、版权声明和版本修改记录。 - 使用标准的 C-Style /**/ 形式注释而非 JavaDoc 注释。 #### 四、命名规范 **1. 基本约定:** - 遵循一致且明确的命名规则。 - 区分...
本文档详细介绍了Java编码规范的重要内容,包括命名规范、编码规范、源文件编写规范、注释和JavaDoc、排版规范以及ECLIPSE代码模板与格式化模板等内容。这些规范旨在帮助开发者编写出高质量、易于维护的代码。 ####...
- **步骤**:在Eclipse中,依次点击`Preferences > Java > Code Style > Code Templates`,可以导入或配置各种注释模板。 - **示例**:导入预设的类注释模板。 ##### 5.2 格式化模板 - **步骤**:在Eclipse中,...