`
TRAMP_ZZY
  • 浏览: 140049 次
社区版块
存档分类
最新评论

Java 注释规范

    博客分类:
  • Java
 
阅读更多
<?xml version="1.0" encoding="UTF-8" standalone="no"?><templates><template autoinsert="false" context="gettercomment_context" deleted="false" description="Comment for getter method" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.gettercomment" name="gettercomment">/**
 * ${bare_field_name}
 * @return the ${bare_field_name}
 */</template><template autoinsert="false" context="settercomment_context" deleted="false" description="Comment for setter method" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.settercomment" name="settercomment">/**
 * ${param}
 *
 * @param ${param} the ${bare_field_name} to set
 */</template><template autoinsert="false" context="constructorcomment_context" deleted="false" description="Comment for created constructors" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.constructorcomment" name="constructorcomment">/**
 * Create a new instance of ${enclosing_type}.
 *
 * ${tags}
 */</template><template autoinsert="false" context="filecomment_context" deleted="false" description="Comment for created Java files" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.filecomment" name="filecomment">/**
 * Project Name: ${project_name}
 * File Name: ${file_name}
 * Package Name: ${package_name}
 * Date: ${date} ${time}
 * Copyright (c) ${year}, zhangzhaoyu0524@163.com All Right  Reserved. 
 */</template><template autoinsert="false" context="typecomment_context" deleted="false" description="Comment for created types" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.typecomment" name="typecomment">/**
 * ClassName: ${type_name} &lt;br /&gt;
 * Function: ${todo} ADD FUNCTION. &lt;br /&gt;
 * date: ${date} ${time} &lt;br /&gt;
 * 
 * @author ${user}
 * @version ${enclosing_type} ${tags}
 * @since JDK 1.7
 */</template><template autoinsert="false" context="fieldcomment_context" deleted="false" description="Comment for fields" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.fieldcomment" name="fieldcomment">/**
 * ${field}:${todo}
 * @since JDK 1.7
 */</template><template autoinsert="false" context="methodcomment_context" deleted="false" description="Comment for non-overriding methods" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.methodcomment" name="methodcomment">/**
 * ${enclosing_method}:&lt;br /&gt;
 * ${todo}
 *
 * @author ${user}
 * ${tags}
 */</template><template autoinsert="false" context="overridecomment_context" deleted="false" description="Comment for overriding methods" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.overridecomment" name="overridecomment">/* (non-Javadoc)
 * ${todo}
 * ${see_to_overridden}
 */</template><template autoinsert="true" context="delegatecomment_context" deleted="false" description="Comment for delegate methods" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.delegatecomment" name="delegatecomment">/**
 * ${tags}
 * ${see_to_target}
 */</template><template autoinsert="false" context="newtype_context" deleted="false" description="Newly created files" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.newtype" name="newtype">/** 
 * Project Name:${project_name} 
 * File Name:${file_name} 
 * Package Name:${package_name} 
 * Date:${date} ${time} 
 * Copyright (c) ${year}, zhangzhaoyu0524@163.com All Rights Reserved. 
 * 
*/  
${filecomment}  
  
${package_declaration}  
/** 
 * ClassName:${type_name} &lt;br/&gt; 
 * Function: ${todo} ADD FUNCTION. &lt;br/&gt; 
 * Reason:   ${todo} ADD REASON. &lt;br/&gt; 
 * Date:     ${date} ${time} &lt;br/&gt; 
 * @author   ${user} 
 * @version   
 * @since    JDK 1.7 
 * @see       
 */  
${typecomment}  
${type_declaration} </template><template autoinsert="true" context="classbody_context" deleted="false" description="Code in new class type bodies" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.classbody" name="classbody">
</template><template autoinsert="true" context="interfacebody_context" deleted="false" description="Code in new interface type bodies" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.interfacebody" name="interfacebody">
</template><template autoinsert="true" context="enumbody_context" deleted="false" description="Code in new enum type bodies" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.enumbody" name="enumbody">
</template><template autoinsert="true" context="annotationbody_context" deleted="false" description="Code in new annotation type bodies" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.annotationbody" name="annotationbody">
</template><template autoinsert="true" context="catchblock_context" deleted="false" description="Code in new catch blocks" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.catchblock" name="catchblock">// ${todo} Auto-generated catch block
${exception_var}.printStackTrace();</template><template autoinsert="true" context="methodbody_context" deleted="false" description="Code in created method stubs" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.methodbody" name="methodbody">// ${todo} Auto-generated method stub
${body_statement}</template><template autoinsert="true" context="constructorbody_context" deleted="false" description="Code in created constructor stubs" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.constructorbody" name="constructorbody">${body_statement}
// ${todo} Auto-generated constructor stub</template><template autoinsert="true" context="getterbody_context" deleted="false" description="Code in created getters" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.getterbody" name="getterbody">return ${field};</template><template autoinsert="true" context="setterbody_context" deleted="false" description="Code in created setters" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.setterbody" name="setterbody">${field} = ${param};</template></templates>
分享到:
评论

相关推荐

    java注释规范

    Java 注释规范详解 Java 注释规范是 Java 语言中一个非常重要的部分,它不仅能够提高代码的可读性和可维护性,还能够帮助其他开发者更好地理解代码的逻辑和意图。下面我们将详细介绍 Java 注释规范的各个方面。 ...

    Java注释规范

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

    java注释规范文档

    ### Java注释规范详解 #### 一、引言 在软件开发过程中,代码注释扮演着极其重要的角色。良好的注释不仅可以帮助其他开发者快速理解代码的功能和用途,还能提高整个团队的工作效率。Java作为一种广泛使用的编程...

    Java注释规范整理.pdf

    ### Java注释规范详解 #### 一、引言 在软件开发过程中,代码注释扮演着极其重要的角色。良好的注释不仅有助于提升代码的可读性和可维护性,还能促进团队成员之间的有效沟通。然而,关于Java注释的具体规范却常常...

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

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

    java注释规范.pdf

    ### Java注释规范 Java注释规范主要规定了如何在Java编程中恰当地使用注释,以便于代码的维护、阅读和理解。注释不仅可以为代码的功能提供说明,还能帮助理解复杂的算法逻辑,同时在进行团队协作时,也便于其他成员...

    Java注释规范整理1

    Java编程语言的注释规范是确保代码可读性和团队协作效率的关键要素。...总之,Java注释规范是提高代码质量、促进团队合作和降低维护成本的有效工具。遵循这些规范和技巧,可以编写出易于理解和维护的高质量代码。

    Java注释规范整理.docx

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

    JAVA注释规范 内容来自网络

    ### JAVA注释规范详解 #### 一、引言 在软件开发过程中,良好的代码注释习惯对于提升代码可读性、降低后期维护成本至关重要。然而,在很多情况下,开发者们并没有一个明确而统一的注释规范作为参考标准。本文旨在...

    JAVA注释规范

    ### JAVA注释规范详解 #### 一、引言 在软件开发过程中,良好的代码注释习惯不仅能够提高代码的可读性和可维护性,还能帮助团队成员更快地理解和使用现有代码。本文档将详细介绍JAVA注释规范的具体内容,包括但不...

    如何更好的规范java 注释

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

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

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

    编程注释规范(JAVA)

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

    java开发注释规范

    java企业开发中的注释规范,方法、类、codetemplates

    java中的注释规范

    以下是关于Java注释的详细说明: 1. **单行注释**:使用`//`来创建单行注释。它适用于快速添加简单解释或临时注解。在实际应用中,如果单行注释不能充分表达意图,建议使用多行块注释。单行注释应该在代码上方留一...

    JAVA代码注释规范codetemplates.xml

    JAVA代码注释规范codetemplates.xml,可直接导入Eclipse,代码注释效果很棒!

    java 编码规范文档

    Java注释规范 - **3.1 单行注释**:注释应简洁明了,使用`//`符号。 - **3.2 类注释**:对类进行简短描述,通常位于类声明之前。示例:`/** * 这是一个示例类。 */ public class ExampleClass { }`。 - **3.3 方法...

    java命名规范以及注释规范

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

    java代码规范示例

    Java 代码规范示例中,涵盖了 Java 项目中包、类、方法、注释等多个方面的规范。 首先,从文件头的注释部分可以看到,这个 Java 文件是一个 FTP 帮助类,负责实现 FTP 的上传和下载功能。这个类名为 FtpHelper,...

Global site tag (gtag.js) - Google Analytics