`

个人Java注释规范

阅读更多

使用Eclipse创建和改变注释步骤菜单栏Window-->Preferences-->Java-->Code Style-->Code Templates-->Comments


1,节点Files

 

2,节点Types

/**

 * @class: ${type_name}

 * @package: ${package_name}

 * @description: ${todo}

 * @author: forestqqqq@163.com 

 * @date: ${date} ${time}

 * @version: 1.0

 */

 

3,节点Fields

/** 

 * 

 */

 

4,节点Constructors

/**  

 * @description: ${todo}

 * ${tags}

 * @author: forestqqqq@163.com

 * @date: ${date} ${time}

 * @version: 1.0

 */

 

5,节点Methods

/** 

 * @method: ${enclosing_method}

 * @description: ${todo}

 * ${tags}

 * @return: ${return_type}

 * @author: forestqqqq@163.com 

 * @date: ${date} ${time}

 * @version: 1.0

 */

 

6,节点Overriding methods

/* (非 Javadoc) 

* <p>title: ${enclosing_method}</p> 

* <p>description: </p> 

* ${tags} 

* ${see_to_overridden} 

*/

 

7,节点Delegate methods

/** 

* ${tags} 

* ${see_to_target} 

*/ 

 

8,节点Getters

 

9,节点Setters

分享到:
评论

相关推荐

    Java注释规范

    Java 注释规范 Java 注释规范是为了让项目中所有的文档都看起来像一个人写的,增加可读性,减少项目组中因为换人而带来的损失。该规范定义了 Java 项目中注释的规范和要求,包括注释的类型、注释的内容、注释的位置...

    java的注释规范(单行注释、多行注释、分块注释)

    java 注释规范详解 java 注释规范是 Java 开发过程中不可或缺的一部分,它的目的是让项目中所有的文档都看起来像一个人写的,增加可读性,减少项目组中因为换人而带来的损失。java 注释规范可以分为三种:单行注释...

    编码规范 注释规范 代码风格 JAVA

    总结来说,理解和遵循编码规范、注释规范以及代码风格对于任何Java开发者都是至关重要的。华为的这些资源提供了一套完整的框架,旨在帮助开发团队产出高质量、易维护的代码。通过深入学习和应用这些规范,开发者不仅...

    如何更好的规范java 注释

    在软件开发中,Java注释是提高代码可读性和维护性的重要组成部分。本文将详细介绍Java注释的规范,帮助开发者更好地理解和遵循注释的最佳实践。...因此,重视并执行Java注释规范是每个专业开发者的必备技能。

    java命名规范以及注释规范

    6. **注释规范**: - 注释用于生成HTML格式的代码文档,应位于类、域、构造函数、方法和定义之前。 - 注释分为描述和块标记两部分,如Javadoc格式: ```java /** * 描述部分,解释该方法的功能。 * * @param ...

    Java注释规范整理.docx

    Java注释规范的制定,旨在提供一种标准化、可操作的注释方法,以解决在快速迭代和多人协作中代码可读性差、维护困难等问题。规范的制定基于对以下问题的深入思考:面对陌生代码如何快速理解其功能?如何避免注释内容...

    JAVA编程注释规范详解

    ### JAVA编程注释规范详解 ...遵循一致的注释规范不仅可以提升个人编码效率,还能促进团队间的协作与交流。通过本文介绍的Java编程注释规范,希望每位开发者都能养成优秀的注释习惯,编写出既优雅又实用的代码。

    java注释模板.zip

    Java注释模板就是为了帮助开发者快速、规范地添加注释而设计的。本文将深入探讨Java注释模板的重要性、类型以及如何使用。 一、注释模板的重要性 1. 提高代码可读性:良好的注释能够清晰地解释代码的功能、逻辑和...

    java 注释风格和java格式风格模版

    首先,Java注释风格主要有三种: 1. 单行注释:使用`//`标记,常用于快速添加临时性的或者行内的注释。 2. 多行注释:使用`/* */`包裹,适合对代码块进行解释,可以跨越多行。 3. Javadoc注释:以`/** */`形式存在...

    编程注释规范(JAVA)

    遵循上述Java注释规范,可以有效地提升代码质量和团队合作效率,使得代码更易于理解和维护,同时也能反映出程序员的专业素养。因此,无论是个人编程还是团队开发,都应该重视并坚持注释规范的执行。

    JAVA注释模板

    本文将详细介绍如何在Eclipse中配置和使用JAVA注释模板。 1. **注释的作用** - **解释代码**:注释能够解释代码的功能,逻辑和设计决策,使其他开发者更容易理解。 - **文档生成**:通过Javadoc工具,Java注释...

    java 注释模版那些事儿

    总之,Java注释模板是提高开发效率的有效工具,它允许开发者快速创建标准化、结构化的注释。通过自定义`codetemplates_formyself.xml`这样的配置文件,开发者可以根据个人和团队的需求定制代码生成模板,从而提升...

    阿里java开发规范插件idea eclipse

    这些规范涵盖命名规则、注释规范、异常处理、空值检查、代码结构等多个方面,旨在确保代码的统一性和可维护性。例如,类名应使用驼峰式命名,常量全大写,变量名首字母小写等。插件会实时检查开发者编写的代码,如果...

    Java编程规范 中文版

    二、注释规范 1. 类和接口应有详细的Javadoc注释,介绍其功能、用途和使用方法。 2. 方法和变量也应有简短的Javadoc注释,说明其作用。 3. 源代码中避免过多的内联注释,保持代码清晰简洁。 4. 注释应及时更新,以...

    JAVA编程规范_Java编程规范_

    3. **注释规范**: - 使用Javadoc为公共API提供文档。 - 注释应清晰、简洁,解释代码目的,而非代码做什么。 - 单行注释用于临时或快速注解,多行注释用于解释复杂的逻辑或方法。 - 避免无用的注释,如对明显...

    java注释模板eclipse

    Java注释模板在Eclipse中的应用是提升代码质量和团队协作效率的重要工具。Eclipse作为一款强大的Java集成开发环境,提供了一种自定义和自动化注释的功能,使得开发人员能够快速生成一致、规范的代码注释,从而提高...

    Java编码规范2008版.pdf

    2. Java编码规范:这部分是文档的核心,具体分为格式自动化设置、命名规范、排版规范和注释规范四个大类。 2.1 格式自动化设置:涵盖了代码注释格式化设置、代码内容格式化设置、代码清理格式化设置以及格式化设置...

    Java虚拟机规范pdf

    JVM规范是一份详细说明Java虚拟机工作方式的文档,它定义了虚拟机的指令集、数据类型、堆栈结构、垃圾回收机制等一系列实现细节。对于Java程序员而言,深入学习JVM规范有助于加深对Java语言底层运行原理的理解,提升...

    Java编码规范终极版

    #### 三、注释规范 注释是代码的重要组成部分,能够帮助其他开发者更好地理解代码的意图和逻辑。此部分提供了关于注释的详细指导: 1. **基本原则**:注释应当简洁明了,旨在增强代码的可读性和清晰度。 2. **避免...

Global site tag (gtag.js) - Google Analytics