`
wei5201
  • 浏览: 187292 次
  • 性别: Icon_minigender_1
  • 来自: 北京
社区版块
存档分类
最新评论

eclipse中的代码注释格式

阅读更多
设置注释模板的入口: Window->Preference->Java->Code Style->Code Template 然后展开Comments节点就是所有需设置注释的元素啦。现就每一个元素逐一介绍:

文件(Files)注释标签:

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

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

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


字段(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}
*/

注释模板使用方法:

创建新类的时候,勾上“Generate comments”选项即可。新创建的类中,自动添加了你的注释模板中定义好了的注释。


分享到:
评论

相关推荐

    Eclipse 代码注释模板

    在Eclipse中,用户可以自定义代码注释模板,这通常涉及到类、方法、变量等不同类型的注释结构。`codetemplates.xml`文件就是存储这些自定义模板的配置文件,通过编辑这个文件,我们可以定制符合个人或团队编码规范的...

    eclipse中代码注释模板

    Eclipse作为一款强大的Java IDE,提供了丰富的自定义功能,包括自定义代码注释模板和代码格式化规则。本文将深入探讨如何在Eclipse中设置和利用这些模板,以实现高效且规范的编码实践。 首先,让我们了解**代码注释...

    eclipse代码注释风格

    本文将详细讲解Eclipse中的代码注释风格,以及如何设置和使用这些风格。 一、代码注释类型 Eclipse支持三种主要的注释类型: 1. 单行注释:以`//`开始,用于快速添加临时或简单的注释。 2. 多行注释:以`/*`开始,...

    Eclipse代码注释模板——code templates

    **Eclipse代码注释模板** Eclipse的代码注释模板允许用户自定义不同类型的注释模板,如类、方法、变量等。这些模板可以在编写代码时自动插入,减少手动输入的时间。模板支持包括但不限于以下类型: 1. 类注释...

    Eclipse代码注释模板

    Eclipse代码注释模板,可以用于myeclipse等开发IDE,注释包括Class,method等

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

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

    Eclipse设置Java代码格式化(包含阿里格式化脚本).zip

    此外,还可以设置Eclipse在保存文件时自动格式化代码,这可以在`Preferences` -&gt; `General` -&gt; `Editors` -&gt; `Text Editors` 中勾选`Insert spaces for tabs` 和 `Auto format on save`。 总的来说,通过合理配置...

    eclipse系列开发工具代码注释格式

    codetemplates.xml是一个eclipse的系列开发工具的代码注释文档,直接导入即可使用。

    eclipse第二代代码行数、注释行数检查插件

    3. **实时更新**:当开发者在Eclipse中编辑代码时,插件会实时更新代码和注释的统计信息,提供即时反馈,帮助开发者保持代码质量和结构的良好状态。 4. **项目级别统计**:除了单个文件,插件还可以在整个项目范围...

    eclipse代码/注释规范

    以下是一些关于Eclipse代码和注释规范的关键知识点: 1. **编码风格**:Eclipse支持多种编码风格,如Sun Java编程规范或Google Java编程规范。这些风格通常规定了命名约定(如变量、类和方法名)、缩进和空格的使用...

    eclipse代码编码和注释格式xml文件

    eclipse注释模板

    eclipse代码注释模板

    java开发IDE eclipse 的代码注释模板java开发IDE eclipse 的代码注释模板

    eclipse注释模板

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

    eclipse 中的注释 快捷键

    除了注释操作,Eclipse还提供了`Ctrl + Shift + F`用于代码格式化,可以自动调整代码的缩进、空格、括号等,保持代码风格的一致性。 ### 高级编辑功能与快捷键 #### 5. **快速修复:Ctrl + 1** 遇到编译错误或...

    eclipse代码格式化模板和注释格式化模板

    Eclipse 提供了代码格式化和注释模板功能,帮助开发者快速统一代码风格。下面我们将详细探讨这两个方面。 1. **代码格式化模板**: - **CodeFormatter.xml** 文件:这是Eclipse中的代码格式化配置文件,它包含了...

    eclipse代码格式化与注释配置文件

    本篇文章将深入探讨标题所提及的"eclipse代码格式化与注释配置文件",以及如何利用这些配置文件提升开发体验。 首先,`eclipse-java-google-style.xml`是Google提供的Java代码风格指南的Eclipse格式化配置文件。...

    Eclipse Java 注释模板

    在编程世界中,提高效率是每个开发者追求的目标之一。...通过合理的配置和使用,它可以帮助开发者快速创建高质量的代码注释,让代码更易读、更易维护。在日常工作中,我们应该充分利用这样的功能,提高编程的生产力。

    Eclipse代码格式配置规范

    一、Eclipse代码格式化 1. **代码缩进**:在Eclipse中,可以设置代码的缩进方式,通常选择空格而不是制表符,以确保在不同的编辑器中显示的一致性。默认情况下,Java代码通常使用4个空格作为缩进单位。 2. **行宽...

    Eclipse注释模板自定义

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

    eclipse中格式代码配置

    ### Eclipse中格式化Java代码配置详解 在Java开发过程中,代码的规范性和美观性对于提高代码的可读性和可维护性至关重要。Eclipse作为一个广泛使用的Java集成开发环境(IDE),提供了丰富的功能来帮助开发者实现这...

Global site tag (gtag.js) - Google Analytics