java注释模板

合集下载

java文档注释规范（一）

java⽂档注释规范（⼀）https:///huangsiqian/article/details/82725214Javadoc⼯具将从四种不同类型的“源”⽂件⽣成输出⽂档：Java语⾔类的源⽂件（.java），包注释⽂件，概述注释⽂件和其他未处理的⽂件。

包注释⽂件（Package Comment File）每个包都有⾃⼰的⽂档注释。

有两种⽅式来创建包注释⽂件：package-info.java - 可以包含包的声明，包注解（anotation），包注释和Javadoc 标签（tag）。

包注释放在包声明之前。

这是JDK 5.0新引⼊的特性。

如下。

File: java/applet/package-info.java 注意：⽂档注释块内部⾏⾸的*号是可选的/*** Provides the classes necessary to create an applet and the classes an applet uses* to communicate with its applet context.* <p>* The applet framework involves two entities:* the applet and the applet context. An applet is an embeddable window (see the* {@link java.awt.Panel} class) with a few extra methods that the applet context* can use to initialize, start, and stop the applet.** @since 1.0* @see java.awt*/package ng.applet;package.html - 只能包含包注释和Javadoc标签，不能包含包注解。

eclipse中代码注释

eclipse中代码注释1.类注释Window->Preference->Java->Code Style->Code Templatealt+shift+J 默认的快捷键或者先敲“/”在敲两个**，然后回车/*** @Description 学习使⽤sikuli* @author Administrator* @Date 2016年7⽉13⽇* @Time 下午9:57:02*/如果把时间设置成 @Date ${Date}${Time},则时间效果如下@Date 2016年7⽉13⽇下午9:58:402.⽅法注释快捷键：先敲“/”在敲两个**，然后回车⼀个${tags}会显⽰所有，有参数就会显⽰参数，有抛出异常就会获取异常说明ps：如上图所⽰，当我们点击Comments下的⼦菜单时，下⾯的Pattern会显⽰Java⽂件的头部注释。

下⾯详细列出每⼀个⼦项的说明：Comments-->Files（Java⽂件注释）Comments-->Types（Java类注释）Comments-->Fields（类字段注释）Comments-->Constructors（构造函数注释）Comments-->Methods（Java⽅法注释）Comments-->Overriding methods（重写⽅法注释）Comments-->Delegate methods（代理⽅法注释）Comments-->Getters（Java Getter⽅法注释）Comments-->Setters（Java Setters⽅法注释）Code下的⼦菜单说明：Code-->New Java files（新建java⽂件代码模板）Code-->Method body（⽅法体模板）Code-->Constructor body（构造函数模板）Code-->Getter body（字段Getter⽅法模板）Code-->Setter body（字段Setter⽅法模板）Code-->Catch block body（异常catch代码块模板）设置Code Templates的⽬的主要是为了统⼀各种注释的格式以及代码的模板，只要设定好Code Templates之后利⽤Eclipse就可以⽅便地⽣成我们⾃定义的注释。

Java文档注释用法+JavaDoc的使用说明

Java⽂档注释⽤法+JavaDoc的使⽤说明简介⽂档注释负责描述类、接⼝、⽅法、构造器、成员属性。

可以被JDK提供的⼯具 javadoc 所解析，⾃动⽣成⼀套以⽹页⽂件形式体现该程序说明⽂档的注释。

注意：⽂档注释必须写在类、接⼝、⽅法、构造器、成员字段前⾯，写在其他位置⽆效。

写在类上⾯的JavaDoc写在类上的⽂档标注⼀般分为三段：第⼀段：概要描述，通常⽤⼀句或者⼀段话简要描述该类的作⽤，以英⽂句号作为结束第⼆段：详细描述，通常⽤⼀段或者多段话来详细描述该类的作⽤，⼀般每段话都以英⽂句号作为结束第三段：⽂档标注，⽤于标注作者、创建时间、参阅类等信息第⼀段：概要描述单⾏⽰例：package org.springframework.jdbc.core;/*** Simple adapter for {@link PreparedStatementSetter} that applies a given array of arguments.**/public class ArgumentPreparedStatementSetter implements PreparedStatementSetter, ParameterDisposer {}多⾏⽰例：package ng;/*** The {@code Long} class wraps a value of the primitive type {@code* long} in an object. An object of type {@code Long} contains a* single field whose type is {@code long}.** <p> In addition, this class provides several methods for converting* a {@code long} to a {@code String} and a {@code String} to a {@code* long}, as well as other constants and methods useful when dealing* with a {@code long}.** <p>Implementation note: The implementations of the "bit twiddling"* methods (such as {@link #highestOneBit(long) highestOneBit} and* {@link #numberOfTrailingZeros(long) numberOfTrailingZeros}) are* based on material from Henry S. Warren, Jr.'s <i>Hacker's* Delight</i>, (Addison Wesley, 2002).** @author Lee Boynton* @author Arthur van Hoff* @author Josh Bloch* @author Joseph D. Darcy* @since JDK1.0*/public final class Long extends Number implements Comparable<Long> {}在注释中出现以@开头的东东被称之为Javadoc⽂档标记，是JDK定义好的如@author、@version、@since、@see、@link、@code、@param、@return、@exception、@throws等。

java优雅注释原则和代码格式列举

java优雅注释原则和代码格式列举Java作为一种高级编程语言，注释和代码格式是编写优雅代码的重要组成部分。

本文将列举一些优雅注释原则和代码格式，并提供一些指导意义，帮助读者编写结构清晰且易于阅读的Java代码。

第一条原则是注释的准确性。

注释应该准确描述代码的功能、目的和工作原理。

它们应该足够清晰，以便其他开发人员能够理解代码的意图，并依此进行修改或扩展。

此外，注释还应该包括关于代码的重要信息，例如输入和输出的格式，以及函数或方法的预期行为。

第二条原则是注释的简洁性。

注释应该尽可能简洁明了，避免冗余和重复的描述。

在编写注释时，应该考虑到读者的时间以及注释的可读性。

过长或太多的注释可能会使人感到困惑或厌倦，因此应该尽量保持简洁。

第三条原则是注释的规范性。

代码中的注释应该遵循一定的规范和格式。

这样可以增加代码的可读性，并帮助开发人员更快地理解代码。

例如，可以使用JavaDoc样式的注释，准确地描述方法的参数、返回值和异常。

此外，注释应该按照一定的结构和顺序编写，以增加阅读的连贯性。

除了注释，代码格式也是编写优雅代码的重要方面之一。

以下列举一些常见的代码格式原则。

第一条原则是代码缩进和对齐。

在Java中，使用空格或制表符来缩进代码，并保持一致的格式。

适当的缩进和对齐可以使代码的层次结构更加清晰，便于阅读。

第二条原则是空行的使用。

通过在代码的不同部分之间插入空行，可以增加代码的可读性，并帮助读者更好地理解代码的逻辑。

例如，在方法之间插入空行，以分隔不同功能的代码块。

第三条原则是适当地使用空格。

在Java中，应该在运算符前后、逗号和分号后添加空格，以增加代码的可读性。

这可以帮助他人更容易地理解代码的逻辑和计算。

第四条原则是使用适当的命名约定。

在Java代码中，变量、方法和类的命名应该具有描述性，并遵循一定的命名约定。

例如，变量名应该以小写字母开头，采用驼峰式命名法，以提高代码的可读性和可维护性。

通过遵循这些优雅注释和代码格式原则，开发人员可以编写结构清晰、易于阅读和维护的Java代码。

JAVA代码注释规范

JAVA代码注释规范目录JA V A代码注释规范 (1)注释的原则 (1)注释的简洁 (1)注释的一致性 (1)注释的位置 (2)注释的数量 (2)删除无用注释 (2)复杂的注释 (2)多余的注释 (2)必加的注释 (3)JA V A注释技巧 (3)JA V A注释具体实现 (4)源文件注释 (4)类（模块）注释： (5)接口注释： (5)构造函数注释： (6)方法注释： (6)方法内部注释： (7)全局变量注释： (7)局部（中间）变量注释： (7)常量 (7)p.s. 注释使用统一的注释文件 (8)注释的原则注释形式统一在整个应用程序中，使用具有一致的标点和结构的样式来构造注释。

如果在其他项目组发现他们的注释规范与这份文档不同，按照他们的规范写代码，不要试图在既成的规范系统中引入新的规范。

注释的简洁内容要简单、明了、含义准确，防止注释的多义性，错误的注释不但无益反而有害。

注释的一致性在写代码之前或者边写代码边写注释，因为以后很可能没有时间来这样做。

另外，如果有机会复查已编写的代码，在今天看来很明显的东西六周以后或许就不明显了。

通常描述性注释先于代码创建，解释性注释在开发过程中创建，提示性注释在代码完成之后创建。

修改代码的同时修改相应的注释，以保证代码与注释的同步。

注释的位置保证注释与其描述的代码相邻，即注释的就近原则。

对代码的注释应放在其上方相邻或右方的位置，不可放在下方。

避免在代码行的末尾添加注释；行尾注释使代码更难阅读。

不过在批注变量声明时，行尾注释是合适的；在这种情况下，将所有行尾注释要对齐。

注释的数量注释必不可少，但也不应过多，在实际的代码规范中，要求注释占程序代码的比例达到20%左右。

注释是对代码的“提示”，而不是文档，程序中的注释不可喧宾夺主，注释太多了会让人眼花缭乱，注释的花样要少。

不要被动的为写注释而写注释。

删除无用注释在代码交付或部署发布之前，必须删掉临时的或无关的注释，以避免在日后的维护工作中产生混乱。

java script 注释

java script 注释JavaScript注释是在代码中用于解释和说明代码的部分。

它们不会被浏览器执行，只是用来帮助开发人员理解代码的作用和功能。

在本文中，我们将探讨JavaScript注释的不同类型和如何正确使用它们。

一、单行注释单行注释是在一行代码中添加注释的最简单方式。

它们以两个斜杠（//）开头，并且可以在任何代码行的末尾添加。

单行注释通常用于解释代码的某个特定部分，或者提供一些关于代码的额外信息。

例如：// 这是一个单行注释，用于解释代码的作用二、多行注释多行注释是用于注释多行代码的一种方式。

它们以斜杠和星号（/*）开始，并以星号和斜杠（*/）结束。

多行注释通常用于描述代码块的功能或详细说明复杂算法的步骤。

例如：/*这是一个多行注释的示例。

它可以用于注释多行代码。

*/三、文档注释文档注释是一种特殊类型的注释，用于生成代码文档。

它们以两个星号（/**）开头，并以星号和斜杠（*/）结束。

文档注释通常用于描述函数、类或模块的功能、参数、返回值等详细信息。

例如：/*** 这是一个用于计算两个数字之和的函数。

* @param {number} a - 第一个数字* @param {number} b - 第二个数字* @returns {number} - 两个数字的和*/function add(a, b) {return a + b;}四、注意事项在使用JavaScript注释时，有一些注意事项需要遵守。

首先，注释应该简洁明了，不要过度解释代码的显而易见的部分。

其次，注释应该与代码保持同步，如果代码发生更改，注释也应相应更新。

此外，注释应该是准确的，不要提供错误的信息或产生歧义。

例如，以下是一个不良的注释示例：// 这是一个用于计算两个数字之差的函数function subtract(a, b) {return a * b;}在这个例子中，注释错误地描述了函数的功能，导致代码的理解产生了困惑。

java 获取类注释及方法注释

一、概述在Java编程中，注释是一种给代码添加说明和解释的方式。

在编写类和方法时，为了方便阅读和理解代码，通常需要添加类注释和方法注释。

本文将介绍如何在Java中获取类注释和方法注释的方法。

二、获取类注释1. 使用反射机制在Java中，可以使用反射机制来获取类的注释信息。

通过反射可以获取类的所有信息，包括注释。

下面是一个简单的示例：```javaClass clazz = Class.forName(.example.TestClass");String classComment =clazz.getCanonicalName().getClass().getAnnotation(Comment.cl ass).value();System.out.println("类注释：" + classComment);```2. 使用工具类除了使用反射机制，还可以使用一些Java类库提供的工具类来获取类的注释。

可以使用Apache Commons Lang库中的ClassUtils类来获取类的注释：```javaString classComment =ClassUtils.getShortClassName(TestClass.class) + " - " + ClassUtils.getPackageCanonicalName(TestClass.class); System.out.println("类注释：" + classComment);```三、获取方法注释1. 使用反射机制和获取类注释类似，使用反射机制也可以获取方法的注释信息。

下面是一个简单的示例：```javaClass clazz = Class.forName(.example.TestClass");Method[] methods = clazz.getDeclaredMethods();for (Method method : methods) {if (method.isAnnotationPresent(Comment.class)) {String methodComment =method.getAnnotation(Comment.class).value();System.out.println("方法注释：" + methodComment);}}```2. 使用工具类同样地，可以使用一些Java类库提供的工具类来获取方法的注释。

java 版权注释说明

java 版权注释说明Java版权注释说明在编写Java程序时，经常需要在代码中添加版权注释说明。

版权注释是对代码版权归属、作者信息、许可证等信息的声明，可以保护程序的知识产权，防止他人滥用或盗用代码。

本文将详细介绍Java 版权注释的规范和使用方法。

一、版权注释的作用版权注释是程序员为了保护自己的代码权益而添加的一段文字，它包含了代码的版权归属、作者信息、许可证等内容。

版权注释的作用主要有以下几点：1. 明确版权归属：版权注释可以明确代码的版权归属，避免他人滥用或盗用代码。

2. 保护知识产权：通过版权注释，程序员可以声明自己对代码的知识产权，避免他人未经授权使用代码。

3. 提供作者信息：版权注释中包含了作者的信息，可以让其他人了解到代码的作者是谁。

4. 规范开源许可证：通过版权注释，可以明确代码采用的开源许可证，让其他人了解到代码的使用规范。

二、版权注释的格式在Java中，版权注释通常放置在源代码文件的开头，以多行注释的形式进行添加。

* 具体的许可证条款请查阅许可证文档。

三、版权注释的准则在使用Java版权注释时，需要遵循以下几个准则：1. 明确版权归属：版权注释中应明确程序的版权归属，包括公司或个人的名称。

2. 作者信息：版权注释中应包含作者的姓名或用户名，方便其他人了解代码的作者。

3. 创建日期：版权注释中应包含程序的创建日期，方便其他人了解代码的起始时间。

4. 版本号：版权注释中应包含程序的版本号，方便自己和他人跟踪代码的版本信息。

1、下载文档前请自行甄别文档内容的完整性，平台不提供额外的编辑、内容补充、找答案等附加服务。
2、"仅部分预览"的文档,不可在线预览部分如存在完整性等问题,可反馈申请退款(可完整预览的文档不适用该条件!)。
3、如文档侵犯您的权益，请联系客服反馈,我们会尽快为您处理(人工客服工作时间：9:00-18:30)。

<?xml version="1.0" encoding="UTF-8"?><templates><template autoinsert="false" 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="constructorcomment_context" deleted="false" description="Comment for created constructors" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.constructorcomment"name="constructorcomment">/*** <p>Title: </p>* <p>Description: </p>* ${tags}*/</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">/*** @Fields ${field} : ${todo}*/</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">/*** <p>* 文件名称: ${file_name}* </p>* <p>* 文件描述: ${todo}* </p>* <p>* 版权所有: 版权所有(C)${year}* </p>* <p>* 内容摘要: 简要描述本文件的内容，包括主要模块、函数及能的说明* </p>* <p>* 其他说明: 其它内容的说明* </p>* <p>* 完成日期: ${date}* </p>* <p>* 修改记录1:* </p>** <pre>* 修改日期:* 修改人:* 修改内容:* </pre>* <p>* 修改记录2：…* </p>** @author lishenyun*/</template><template autoinsert="true" context="settercomment_context" deleted="false" description="Comment for setter method" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.settercomment" name="settercomment">/*** @param ${param} the ${bare_field_name} to set*/</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">/*** @author：Lishenyun* @date：${date}* @Description：方法功能描述* ${tags}: 返回结果描述* @return ${return_type}: 返回值类型* @throws*/</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">/*** <p>文件名称: ${file_name}</p>* <p>文件描述: 本类描述</p>* <p>版权所有: 版权所有(C)${year}</p>* <p>内容摘要: 简要描述本文件的内容，包括主要模块、函数及能的说明</p> * <p>其他说明: 其它内容的说明</p>* <p>完成日期: ${date} ${time}</p>* <p>修改记录1:</p>* <pre>* 修改日期:* 修改人:* 修改内容:* </pre>* <p>修改记录2：…</p>* @author Lishenyun*/</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">/* (非Javadoc)* <p>Title: ${enclosing_method}</p>* <p>Description: </p>* ${tags}* ${see_to_overridden}*/</template><template autoinsert="true" context="gettercomment_context" deleted="false" description="Comment for getter method" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.gettercomment" name="gettercomment">/*** @return the ${bare_field_name}*/</template></templates>【把此文件格式改为xml,导入即可】。