`
xvm03
  • 浏览: 144355 次
  • 来自: ...
社区版块
存档分类
最新评论

转 eclipse注释规范

阅读更多

原:http://www.a18zhizao.cn/y2009/899_ways-to-set-up-eclipse-and-use-the-method-of-template-notes-notes.html

 

文件注释标签:

/**
 * @Title: ${file_name}
 * @Package ${package_name}
 * @Description: ${todo}(用一句话描述该文件做什么)
 * @author A18ccms A18ccms_gmail_com
 * @date ${date} ${time}
 * @version V1.0
 */


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

/**
 * @ClassName: ${type_name}
 * @Description: ${todo}(这里用一句话描述这个类的作用)
 * @author A18ccms a18ccms_gmail_com
 * @date ${date} ${time}
 *
 * ${tags}
 */

字段注释标签:

/**
 * @Fields ${field} : ${todo}(用一句话描述这个变量表示什么)
 */

构造函数标签:

/**
 *

Title: 

 *

Description: 

 * ${tags}
 */

方法标签:

/**
 * @Title: ${enclosing_method}
 * @Description: ${todo}(这里用一句话描述这个方法的作用)
 * @param ${tags}    设定文件
 * @return ${return_type}    返回类型
 * @throws
 */

覆盖方法标签:

/* (非 Javadoc)
*

Title: ${enclosing_method}

*

Description: 

* ${tags}
* ${see_to_overridden}
*/

代表方法标签:

/**
* ${tags}
* ${see_to_target}
*/

getter方法标签:

/**
* @return ${bare_field_name}
*/

setter方法标签:

/**
* @param ${param} 要设置的 ${bare_field_name}
*/

新建Java文件:

${filecomment}
${package_declaration}
/**
 * @Title: ${file_name}
 * @Package ${package_name}
 * @Description: ${todo}(添加描述)
 * @author A18ccms A18ccms_gmail_com
 * @date ${date} ${time}
 * @version V1.0
 */
${typecomment}
${type_declaration}

分享到:
评论

相关推荐

    eclipse代码/注释规范

    在Eclipse中,遵循一定的代码和注释规范对于提高代码可读性、可维护性和团队协作至关重要。以下是一些关于Eclipse代码和注释规范的关键知识点: 1. **编码风格**:Eclipse支持多种编码风格,如Sun Java编程规范或...

    阿里代码注释规范,eclipse必备

    阿里巴巴内部 代码格式化规范xml,code 导入XML 。 阿里巴巴内部 代码格式化规范xml,code 导入XML 阿里巴巴内部 代码格式化规范xml,code 导入XML 阿里巴巴内部 代码格式化规范xml,code 导入XML 阿里巴巴内部...

    Eclipse 代码注释模板

    其中,代码注释模板是一项非常实用的功能,可以帮助程序员快速生成规范、一致的注释,提高开发效率并保持代码的可读性。 在Eclipse中,用户可以自定义代码注释模板,这通常涉及到类、方法、变量等不同类型的注释...

    Eclipse注释模板和格式化模板.zip

    在Eclipse中,注释模板和格式化模板是两个非常实用的功能,可以帮助开发者快速编写规范、一致的代码。本资料包“Eclipse注释模板和格式化模板.zip”包含了配置这两个功能所需的文件。 首先,我们来看看`code...

    Eclipse Java 注释模板

    总之,Eclipse Java注释模板是提升开发效率、保持代码规范的重要工具。通过合理的配置和使用,它可以帮助开发者快速创建高质量的代码注释,让代码更易读、更易维护。在日常工作中,我们应该充分利用这样的功能,提高...

    eclipse注释模板

    代码格式化和代码注释规范,导入eclipse中,一般在类和方法上都必须加通用文档注释,说明类和方法的作用,在特殊字段加相应注释,在复杂代码逻辑加相应行内注释说明代码逻辑。

    Eclipse注释模板自定义

    总结,Eclipse的注释模板自定义功能允许开发者根据个人或团队的需求创建个性化的注释格式,提高代码的可读性和规范性。同时,通过`eclipse.ini`配置文件,可以全局管理版权信息,确保团队代码的统一性和合法性。熟练...

    eclipse代码注释风格

    在编程世界中,代码注释风格是至关重要的,它不仅提高了代码的可读性,也有助于团队协作和代码维护。Eclipse是一款广泛使用的Java集成开发环境(IDE),它...因此,每位Java开发者都应该重视并遵循良好的代码注释规范。

    如何配置Eclipse自定义注释

    本篇将详细介绍如何在Eclipse中配置自定义注释,以提高编码效率和代码规范性。 首先,我们需要了解Eclipse的注释类型。Eclipse支持三种基本的注释类型:单行注释、多行注释和Javadoc注释。单行注释以"//"开头,多行...

    eclipse 注释模板

    注释模板是提高代码规范性和编写文档效率的重要工具,允许开发者预设好常用的注释结构,只需通过快捷键或菜单即可快速插入到代码中。 **Eclipse 注释模板详解** 1. **创建和管理注释模板** 在Eclipse中,你可以...

    Eclipse 添加注释模板

    总结来说,Eclipse的注释模板功能是一种强大的工具,能够帮助开发者规范化代码注释,提高编程效率。通过自定义模板,你可以根据项目需求或个人习惯定制属于自己的代码注释风格。熟练掌握这一技巧,会让你在日常开发...

    eclipse自动注释插件JAutodoc

    Eclipse是一款广泛使用的Java集成开发环境(IDE),它提供了丰富的...总之,JAutodoc是Eclipse开发中的得力助手,它提高了注释编写效率,保证了代码的规范性。对于需要大量注释的项目来说,JAutodoc是必不可少的工具。

    eclipse注释模板xml文件

    在Eclipse中,开发者可以通过自定义注释模板来快速插入预先定义好的注释结构,这对于代码规范和团队协作非常有帮助。这些自定义模板通常存储在一个XML文件中,使得它们可以被共享、导入和导出。 在Eclipse中,注释...

    eclipse 与myeclipse 注释规范设置

    ### Eclipse与MyEclipse注释规范设置详解 在软件开发过程中,良好的代码注释习惯对于提高代码可读性、维护性和团队协作效率至关重要。本文将详细介绍如何在Eclipse与MyEclipse IDE中设置规范化的注释格式,帮助...

    eclipse 注释模版

    总之,Eclipse的代码注释模板是提高开发效率的有效工具,通过合理利用和定制,我们可以使代码更加规范、易读,同时也能提升团队的协同效率。通过下载并比较`codetemplates.xml`文件,你可以找到适合自己的注释风格,...

    eclipse注释模板.xml + 修改模板方法 + 使用方法

    本文将详细介绍如何利用Eclipse创建、修改注释模板,以及如何在实际编码中有效使用这些模板,旨在提高开发效率和代码规范性。 一、Eclipse注释模板 Eclipse的注释模板允许程序员快速插入预定义的注释结构,例如类...

    eclipse/Myeclipse注释模板

    Eclipse 和 MyEclipse 是两款非常流行的 Java 开发集成环境,它们提供了强大的自定义注释模板功能,帮助开发者快速编写规范、一致的注释。本文将详细介绍如何在 Eclipse 和 MyEclipse 中设置和使用注释模板,以及...

    Myeclipse/eclipse注释模板一键导入配置

    在IT行业中,开发人员经常需要编写大量的代码,为了提高代码的可读性和维护性,规范化的注释是必不可少的。Eclipse和MyEclipse作为Java开发的主流集成开发环境(IDE),提供了自定义注释模板的功能,使得我们可以...

    Eclipse代码注释模板——code templates

    总结,Eclipse的代码注释模板是提高编程效率的重要工具,它允许用户根据个人或团队规范创建和使用自定义注释格式。通过`convertion.xml`和`codetemplates.xml`文件,我们可以管理和共享这些模板,确保代码风格的一致...

    jautodoc_1.8.0 eclipse注释插件

    此外,你还可以设置注释的格式,包括字体、颜色、缩进等,以符合团队的编码规范。 JAutodoc的另一个亮点是它的灵活性。你可以为不同的代码类型配置不同的注释模板,比如对于公共方法和私有方法,可能需要的注释内容...

Global site tag (gtag.js) - Google Analytics