Javadoc注释说明
javadoc的注释
javadoc的注释
Javadoc是一种用于Java源代码的注释格式，它可以被特定的工具提取并转换成一份可供开发者参考的文档。
Javadoc注释以`/`开头，以`/`结尾，通常位于类、方法或字段的前面。
它们允许开发者描述代码的功能、参数、返回值以及可能的异常情况。
Javadoc 注释通常包括以下几个部分：
1. 描述部分，对于类、方法或字段的描述，通常包括其作用、使用方法等信息。
2. 参数部分，如果是方法的注释，通常会包括对方法参数的描述，包括参数名、参数类型以及参数的作用。
3. 返回部分，对于方法的注释，会描述该方法的返回值类型以及可能的返回值情况。
4. 异常部分，对于方法的注释，会描述该方法可能会抛出的异常类型及异常情况。
Javadoc注释的好处在于它们可以被Javadoc工具解析并生成
代码文档，这样其他开发者就可以通过阅读文档了解代码的功能和
使用方法。
此外，Javadoc注释也可以提高代码的可读性，让其他
开发者更容易理解代码的含义和设计初衷。
除了以上提到的基本部分，Javadoc注释还可以包括一些其他
的标签，比如`@author`用于指定作者、`@version`用于指定版本号、`@see`用于指定相关的链接等。
这些标签可以进一步丰富Javadoc
注释的内容，使得生成的文档更加完整和详尽。
总之，Javadoc注释是Java语言中一种非常有用的注释格式，
它可以帮助开发者更好地理解和使用代码，同时也为代码文档的生
成提供了便利。
因此，在编写Java代码时，合理、规范地使用Javadoc注释是非常重要的。
JavaDOC注释使用方法
JavaDOC注释使用方法JavaDOC注释使用方法目录前言一. Java 文档和 javad oc二. 文档注释的格式1. 文档注释的格式化2. 文档注释的三部分三. 使用 javadoc 标记1. @see 的使用2. 使用 @author、@version 说明类3. 使用 @param、@return 和 @exception 说明方法四. javadoc 命令前言Java 的语法与 C++ 及为相似，那么，你知道 Java 的注释有几种吗,是两种,// 注释一行/* ...... */ 注释若干行不完全对，除了以上两种之外，还有第三种，文档注释:/** ...... */ 注释若干行，并写入 javadoc 文档通常这种注释的多行写法如下:/*** .........* .........*/一. Java 文档和 javadocJava 程序员都应该知道使用 JDK 开发，最好的帮助信息就来自 SUN 发布的 Java 文档。
它分包、分类详细的提供了各方法、属性的帮助信息，具有详细的类树信息、索引信息等，并提供了许多相关类之间的关系，如继承、实现接口、引用等。
Java 文档全是由一些 html 文件组织起来的，在 SUM 的站点上可以下载它们的压缩包。
但是你肯定想不到，这些文档我们可以自己生成。
安装了 JDK 之后，安装目录下有一个 src.jar 文件或者 src.zip 文件，它们都是以 ZIP 格式压缩的，可以使用 WinZip 解压。
解压之后，我们就可以看到分目录放的全是 .java 文件。
是了，这些就是 Java 运行类的源码了，非常完整，连注释都写得一清二楚……不过，怎么看这些注释都有点似曾相识的感觉, 这就不奇怪了，我们的迷底也快要揭开了。
如果你仔细对比一下 .java 源文件中的文档注释 (/** ... */) 和 Java 文档的内容，你会发现它们就是一样的。
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标签，不能包含包注解。
idea设置创建类的注释
idea设置创建类的注释
一．创建类的注释
在IDEA中，可以创建类的注释，以便在编写代码时快速了解类的作用和使用说明。
1. 选择添加注释的类，单击右键，选择“Generate（生成）”->“Javadoc...（Javadoc...）”；
2. 在弹出的对话框中，勾选“Class（类）”、“Description（描述）”，设置其他参数，如版权信息、作者、创建日期等；
3. 在“Description（描述）”文本框中可以输入类的简介、用法、说明等；
4. 勾选“Fields（字段）”，IDEA会自动列出类中的所有字段，可以对每个字段进行注释；
5. 选择“Methods（方法）”，IDEA将自动列出类中的所有方法，可以对每个方法进行注释；
6. 点击“OK”按钮，IDEA就会自动为类生成注释。
- 1 -。
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等。
javadocument 的添加方法
javadocument 的添加方法【原创版3篇】《javadocument 的添加方法》篇1要在Java 中添加文档，可以使用Java 文档注释。
以下是添加文档注释的一般方法:1. 在需要添加文档注释的类、方法、字段等上面使用/**... */ 注释形式。
例如，要在一个类上添加文档注释，可以这样写:```/*** 这是一个示例类。
* 它包含一些示例方法和字段。
*/public class ExampleClass {// 示例字段private int exampleField;// 示例方法public void exampleMethod() {// 方法体}}```2. 在文档注释中使用特定的标记语法来表示不同的注释内容。
例如，使用@param 注释标记来标记方法参数的注释:```public void exampleMethod(@Param("exampleParam") String exampleParam) {// 方法体}```使用@return 注释标记来标记方法返回值的注释:```public String exampleMethod() {// 方法体return "exampleReturnValue";}```使用@author 注释标记来标记作者的注释:```/*** 这是一个示例类。
* 它包含一些示例方法和字段。
** @author John Doe*/public class ExampleClass {// 示例字段private int exampleField;// 示例方法public void exampleMethod() {// 方法体}}```3. 在文档注释中使用HTML 标签和格式来增强文档的可读性和可维护性。
例如，使用<pre> 标签来表示代码块:```/*** 这是一个示例类。
* 它包含一些示例方法和字段。
注释规范
ActionForm form, HttpServletRequest request,
HttpServletResponse response) {
……………
｝
四、代码内的注释 1、单独行注释：在代码中单起一行注释， 注释前面空一行，并与
其后的代码具有一样的缩进层级。如果单行无法完成，则应采用块注 释。
/** * @todo 注释内容 */
注释规范
注释采用javadoc的注释方法，所有注释放置于所注释目标的上方。 一、类或接口的头注释 /********************************************************** * 类描述信息 * @author 作者信息 * @date 创建日期 * @time 创建时间 * @FileName 文件名字 * @version 类或接口模块的版本号 **********************************************************/
二、属性的注释 格式:
/** * 注释内容 */
…代码(属性)… 生成快捷方法(Myeclipse)：在属性上一行先用键盘打出“/**”再按回
车键即可。
三、方法的头注释
格式:
/**
*方法描述信息
* @param
* @return
* @throws
*/
…代码(方法)…
如：
/**
* 获取新闻的详细信息
格式： /* 注释内容 */ 或 //……注释内容（推存用后者）
2、行头注释：在代码行的开头进行注释,注释前面空一行。主要为 了使该行代码失去意义。
格式： // 注释内容
3、行尾注释：尾端(trailing)--极短的注释，在代码行的行尾进 行注释。一般与代码行后空8（至少4）个格，所有注释必须对齐。
java中的注释类型
java中的注释类型Java中的注释类型Java是一种面向对象的编程语言，它具有强大的功能和灵活的语法。
在Java中，注释是一种非常重要的语言特性，它可以帮助程序员更好地理解代码，提高代码的可读性和可维护性。
Java中有三种注释类型，分别是单行注释、多行注释和文档注释。
1. 单行注释单行注释是Java中最常用的注释类型之一，它以“//”开头，可以在一行中注释掉一段代码或者对代码进行解释。
单行注释通常用于临时注释掉一段代码或者对代码进行简单的解释。
例如：```// 这是一段单行注释int a = 10; // 定义一个整型变量a，赋值为10```2. 多行注释多行注释是Java中另一种常用的注释类型，它以“/*”开头，“*/”结尾，可以注释掉多行代码或者对多行代码进行解释。
多行注释通常用于注释掉一段代码或者对一段代码进行详细的解释。
例如：```/*这是一段多行注释可以注释掉多行代码也可以对多行代码进行解释*/int b = 20; // 定义一个整型变量b，赋值为20```3. 文档注释文档注释是Java中最重要的注释类型之一，它以“/**”开头，“*/”结尾，可以对类、方法、变量等进行详细的解释和说明。
文档注释通常用于生成API文档，帮助其他程序员更好地理解代码的功能和使用方法。
例如：```/*** 这是一个示例类，用于演示文档注释的使用方法*/public class Example {/*** 这是一个示例方法，用于演示文档注释的使用方法* @param a 整型参数a* @param b 整型参数b* @return 返回a和b的和*/public int add(int a, int b) {return a + b;}}```在上面的示例中，我们使用了文档注释对类和方法进行了详细的解释和说明。
在文档注释中，我们可以使用一些特殊的标记来标识参数、返回值、异常等信息，这些标记可以帮助其他程序员更好地理解代码的功能和使用方法。
javaDoc注释规范
javaDoc注释规范Javadoc虽然是Sun公司为Java⽂档⾃动⽣成设计的，可以从程序源代码中抽取类、⽅法、成员等注释形成⼀个和源代码配套的API帮助⽂档。
但是Javadoc的注释也符合C的注释格式，⽽且doxyen也⽀持该种风格的注释。
官⽅⽂档：维基百科：Javadoc 的注释结构和 C 类似。
都以/* 注释 */这种结构。
Javadoc 的内容很多，先学习⼀下 Overview注释，类注释和⽅法注释，其他的以后再学。
先贴出⼏段 Java 的⽰例代码。
概述:/*** @author Firstname Lastname <address @ >* @version 2010.0331 (E.g. ISO 8601 YYYY.MMDD)* @since 1.6 (The Java version used)*/public class Test {// class body}类:/*** A class representing a window on the screen.* For example:* <pre>* Window win = new Window(parent);* win.show();* </pre>** @author Sami Shaio* @version %I%, %G%* @see java.awt.BaseWindow* @see java.awt.Button*/class Window extends BaseWindow {...}字段/变量/*** The X-coordinate of the component.** @see #getLocation()*/int x = 1263732;/*** The horizontal distances of point.*/public int x;⽅法:/*** Returns the character at the specified index. An index* ranges from <code>0</code> to <code>length() - 1</code>.** @param index the index of the desired character.* @return the desired character.* @exception StringIndexOutOfRangeException* if the index is not in the range <code>0</code>* to <code>length()-1</code>.* @see ng.Character#charValue()*/public char charAt(int index) {...}/*** Validates a chess move.** @param theFromFile file from which a piece is being moved* @param theFromRank rank from which a piece is being moved* @param theToFile file to which a piece is being moved* @param theToRank rank to which a piece is being moved* @return true if the move is valid, otherwise false*/boolean isValidMove(int theFromFile, int theFromRank, int theToFile, int theToRank) {// ...body}/*** Moves a chess piece.** @see java.math.RoundingMode*/void doMove(int theFromFile, int theFromRank, int theToFile, int theToRank) {// ...body}其实这些注释形式都差不多，主要是 tag 不同下⾯介绍⼀下 tag 及含义。
javadoc注释规范
javadoc注释规范javadoc做注释一. Java 文档// 注释一行/* ...... */ 注释若干行/** ...... */ 注释若干行，并写入 javadoc 文档通常这种注释的多行写法如下：/*** .........* .........*/javadoc -d 文档存放目录 -author -version 源文件名.java这条命令编译一个名为“源文件名.java”的 java 源文件，并将生成的文档存放在“文档存放目录”指定的目录下，生成的文档中 index.html 就是文档的首页。
-author 和 -version 两个选项可以省略。
二. 文档注释的格式1. 文档和文档注释的格式化生成的文档是 HTML 格式，而这些 HTML 格式的标识符并不是 javadoc 加的，而是我们在写注释的时候写上去的。
比如，需要换行时，不是敲入一个回车符，而是写入 <br>，如果要分段，就应该在段前写入 <p>。
文档注释的正文并不是直接复制到输出文件 (文档的 HTML 文件)，而是读取每一行后，删掉前导的 * 号及 * 号以前的空格，再输入到文档的。
如/*** This is first line. <br>***** This is second line. <br>This is third line.*/2. 文档注释的三部分先举例如下/*** show 方法的简述.* <p>show 方法的详细说明第一行<br>* show 方法的详细说明第二行* @param b true 表示显示，false 表示隐藏* @return 没有返回值*/public void show(boolean b) {frame.show(b);}第一部分是简述。
文档中，对于属性和方法都是先有一个列表，然后才在后面一个一个的详细的说明简述部分写在一段文档注释的最前面，第一个点号 (.) 之前 (包括点号)。
deprecated javadoc 注释
文章标题：深度探讨：deprecated javadoc 注释的作用与实践一、引言在软件开发中，我们经常会遇到一些旧版本的方法或类需要被替换或删除的情况。
这些被标记为“deprecated”的代码可能会对开发人员造成困扰，因为他们不清楚这些代码是否还可以安全地使用。
在Java 中，我们可以使用Javadoc注释来标记这些过期的代码，以提醒其他开发人员停止使用它们。
本文将深入探讨deprecated javadoc 注释的作用与实践，帮助读者更好地理解并应用这一特性。
二、什么是deprecated javadoc 注释在Java编程语言中，如果一个方法或类被标记为deprecated，意味着它已经被弃用，不建议再使用。
为了让其他开发人员知道这一点，我们可以使用Javadoc注释来标记它。
这样做的目的是为了提醒其他开发人员停止使用这些过期的代码，并提供替代方案。
在Javadoc中，我们可以使用@Deprecated标签来标记一个方法或类。
当其他开发人员在使用这些过期的代码时，编译器会发出警告，提醒他们停止使用这些代码，并查看相应的文档以了解替代方案。
三、deprecated javadoc 注释的作用1. 提醒其他开发人员通过使用deprecated javadoc 注释，我们可以明确地告诉其他开发人员哪些方法或类已经被弃用，不建议再使用。
这样做有利于整个团队在开发过程中避免使用过期的代码，从而提高代码的质量和可维护性。
2. 提供替代方案在deprecated javadoc 注释中，我们可以添加一些说明，介绍为什么这些代码被弃用，以及推荐使用哪些替代方案。
这样做有利于其他开发人员快速找到替代方案，并在代码迁移时更加方便。
3. 保持代码整洁通过及时标记和移除过期的代码，我们可以保持代码库的整洁性和简洁性。
避免过多的过期代码存在于代码库中，有利于团队的代码管理和维护工作。
四、如何使用deprecated javadoc 注释1. 明智地选择标记在使用deprecated javadoc 注释时，我们需要谨慎选择哪些方法或类应该被标记为deprecated。
JAutodoc使用指南
Jautodoc是一款Eclipse插件,主要用于在源代码文件中自动添加Javadoc和文件头.它使用Velocity templates模板,并依据元素名生成相应的注释.特性Jautodoc主要有以下特性:1.模式补全已有Javadoc:已经存在的Javadoc不会被修改或覆盖.只会补充遗漏的标签以及还没有文档化的元素;保持已有Javadoc:已经存在的Javadoc不会被修改或覆盖.遗漏的标签不会补充,但是会文档化之前未文档化的元素;替换已有Javadoc:已有Javadoc将由生成的Javadoc全部替换掉.注意谨慎使用这一选项.2. 可见性•Public, protected, package 或者private可以限定相应可见性层次的属性能创建Javadoc.3.过滤器•注释Types, Fields, Methods 或者Getter/Setter only可以决定那种类型的类成员可以创建Javadoc.4.选项•为自动生成的Javadoc添加ToDo标记目的是便于找到包含自动生成Javadoc的所有源文件。
每个源文件中只生成一次。
依据元素名创建注释设置这个选项后Jautodoc将如下所示依据元素名生成注释。
模板可以定义生成格式，生成方式。
另外，对于方法，字段，参数缩写在”替换”中将定义。
字段:方法：单行字段注释：创建单行注释的选项.使用Eclipse的注释格式化可以使用Eclipse自带的格式化工具对生成的注释进行格式化。
可以在preferences中设置相应的格式样式：字段的getter/setter注释依据字段注释创建Getter/Setter注释文件头•添加/替换文件头如果还没有文件头的话，你可以定义一个文件头添加到源文件中。
你可以选择将已有文件头替换掉。
勾选上“多注释文件头”，则源文件开头的多个注释能被替换掉。
在文件头文本中可以使用V elocity Template Language (VTL) and预定义变量。
Javadoc标签和Javadoc注释规范说明
Javadoc标签和Javadoc注释规范说明最近看源码，⼀些Javadoc常见的注释整理下Javadoc是Sun公司提供的⼀个技术，从程序源代码中抽取类、⽅法、成员等注释形成⼀个和源代码配套的API帮助⽂档。
Javadoc命令是⽤来⽣成⾃⼰的API⽂档，使⽤⽅式：javadoc 源⽂件名.javajavadoc -d ⽂档存放⽬录源⽂件名.java通过IDEA⽣成Javadoc ： Tools -> Generate JavaDocjavadoc标签标签说明@author作者标识@version版本号@return对函数返回值的描述@deprecated标识过期API（为了保证兼容性，仍可⽤，但不推荐⽤）@throws构造函数或⽅法会抛出的异常@exception同@throws@see引⽤，查看相关的内容，如类，⽅法，变量等，必须顶头写{@link 包.类#成员}引⽤，同@see，但可写在任意位置{@value}对常量注释，如果其值包含在⽂档中，通过改标签引⽤常量的值{@code}}{@code text}将⽂本标记为code，会被解析成 text } ,在Javadoc成只要涉及到类名或者⽅法名，都需要使⽤@code进⾏标记@param说明⽅法的参数@inheritDoc⽤于继承⽗类中的Javadoc，⽗类的⽂档注释，被继承到了⼦类javadoc注释规范⼀、 Java⽂档// 注释⼀⾏/ * */ 注释若⼲⾏/** ……*/ 注释若⼲⾏，写⼊Javadoc⽂档⼆、⽂档格式写在类上的⽂档标注⼀般分为三段：第⼀段：概要描述，通常⽤⼀句话或者⼀段话简要描述该类的作⽤，以英⽂句号结束第⼆段：详细描述，通常⽤⼀段或者多段话来详细描述该类的作⽤，⼀般每段话都以英⽂句号作为结束第三段：⽂档标注，⽤于标注作者，创建时间，参阅类等信息⽣成⽂档是HTML格式。
换⾏<br>分段<p>(写在段前）)⽰例/*** show ⽅法的简述.* <p>show ⽅法的详细说明第⼀⾏<br>* show ⽅法的详细说明第⼆⾏* @param b true 表⽰显⽰，false 表⽰隐藏* @return 没有返回值*/public void show(boolean b) {frame.show(b);}补充：Java的三种注释 Javadoc标记*三种注释⽅法：1、单⾏注释 //注释的内容2、多⾏注释 /*......*/3、/**......*/，这种⽅式和第⼆种⽅式相似。
easy javadoc 自定义规则
easy javadoc 自定义规则Easy Javadoc 是一种用于生成Java 代码文档的工具，它可以根据代码中的注释自动生成文档。
本文将介绍如何使用Easy Javadoc 自定义规则来生成符合要求的文档。
我们需要了解Easy Javadoc 的基本用法。
在代码中，我们可以使用特定的注释格式来描述类、方法、变量等的功能和用法，Easy Javadoc 会根据这些注释生成对应的文档。
下面是一个简单的示例：```java/*** 这是一个示例类，用于演示 Easy Javadoc 的使用方法。
*/public class ExampleClass {/*** 这是一个示例方法，用于演示 Easy Javadoc 的使用方法。
** @param param 示例参数* @return 示例返回值*/public String exampleMethod(String param) {return "Hello, " + param + "!";}}```在上面的示例中，我们使用了`/** ... */` 的注释格式来描述类和方法的功能和用法。
在注释中，我们使用`@param` 标签来描述方法参数，使用 `@return` 标签来描述方法返回值。
接下来，我们可以通过在命令行中运行Easy Javadoc 命令来生成文档。
首先，我们需要下载和安装Easy Javadoc 工具。
然后，我们可以在命令行中切换到代码所在的目录，并执行以下命令：```easyjavadoc -sourcepath src -doclet com.example.CustomDoclet -classpath lib -d docs```在上面的命令中，`-sourcepath src` 指定了代码的源文件路径，`-doclet com.example.CustomDoclet` 指定了自定义的Doclet 类，`-classpath lib` 指定了代码依赖的类库路径，`-d docs` 指定了生成的文档输出路径。
idea配置class注释
在使用IntelliJ IDEA 的Java 项目中，你可以在类上添加JavaDoc 注释。
以下是具体的配置步骤：
1. 打开IntelliJ IDEA，进入你的Java 项目。
2. 找到你想要注释的类，并在类的上方输入"/**"。
然后按回车键。
3. IntelliJ IDEA 会自动为你添加JavaDoc 的注释开始符"/*"、注释内容和注释结束符"*/"。
在注释中输入你的类的说明，如类的功能、参数和返回值等。
4. 在类的公共方法上方，输入"/**"。
然后按回车键。
5. IntelliJ IDEA 会自动为你添加JavaDoc 的注释开始符、注释内容和注释结束符。
在注释中输入你的方法的说明、参数和返回值等。
6. 如果你需要更新JavaDoc 注释的模板或风格，可以在IntelliJ IDEA 的设置中进行更改。
在设置中，选择Editor > Code Style > JavaDoc，这里可以修改JavaDoc 注释的格式。
7. 保存你的代码，JavaDoc 注释会在jar 包和HTML 文档中显示。
通过这种方式，你可以为自己的Java 项目添加详细的JavaDoc 注释，并为项目的使用提供更好的说明。
程序代码注释编写规范
优梦优程序代码注释编写规范（试行）为提高控制程序的阅读性与可理解性，现制定相关代码程序代码注释编写的编写规范。
一般情况下，源程序有效注释量必须在20％以上，注释的原则是有助于对程序的阅读理解，在该加的地方都加了，注释不宜太多也不能太少，注释语言必须准确、易懂、简洁。
一、注释条件：1、基本注释（必须加）(a) 类（接口）的注释(b) 构造函数的注释(c) 方法的注释(d) 全局变量的注释(e) 字段/属性的注释备注：简单的代码做简单注释，注释内容不大于10个字即可，另外，持久化对象或VO对象的getter、setter方法不需加注释。
具体的注释格式请参考下面举例。
2、特殊必加注释（必须加）(a) 典型算法必须有注释。
(b) 在代码不明晰处必须有注释。
(c) 在代码修改处加上修改标识的注释。
(d) 在循环和逻辑分支组成的代码中加注释。
(e) 为他人提供的接口必须加详细注释。
备注：此类注释格式暂无举例。
具体的注释格式自行定义，要求注释内容准确简洁。
二、注释格式：1、单行(single-line)注释：“//……”2、块(block)注释：“/*……*/”3、文档注释：“/**……*/”4、javadoc 注释标签语法@author 对类的说明标明开发该类模块的作者@version 对类的说明标明该类模块的版本@see 对类、属性、方法的说明参考转向，也就是相关主题@param 对方法的说明对方法中某参数的说明@return 对方法的说明对方法返回值的说明@exception 对方法的说明对方法可能抛出的异常进行说明三、举例说明：以java语言为例。
1. 类（接口）注释例如：/*** 类的描述* @author Administrator* @Time 2012-11-2014:49:01**/public classTest extends Button { ……}2. 构造方法注释例如:public class Test extends Button {/*** 构造方法的描述* @param name* 按钮的上显示的文字*/public Test(String name){……}}3. 方法注释例如public class Test extends Button {/*** 为按钮添加颜色*@param color按钮的颜色*@return*@exception (方法有异常的话加) * @author Administrator* @Time2012-11-20 15:02:29*/public voidaddColor(String color){ ……}}4. 全局变量注释例如：public final class StringImplementsjava.io.Serializable,Comparable<String>,CharSequence{/** The value is used for characterstorage. */private final char value[];/** The offset is the first index of thestorage that is used. */ private final int offset;/** The count is the number of charactersin the String. */ private final int count;/** Cache the hash code for the string */private int hash; // Default to 0……}5. 字段/属性注释例如：public class EmailBody implements Serializable{private String id;private String senderName;//发送人姓名private String title;//不能超过120个中文字符private String content;//邮件正文private String attach;//附件，如果有的话private String totalCount;//总发送人数private String successCount;//成功发送的人数private Integer isDelete;//0不删除1删除private Date createTime;//目前不支持定时所以创建后即刻发送privateSet<EmailList> EmailList;……}四、本规范要求所有技术人员遵守，如有违背将按违纪（不听指挥）处理。
java注释书写规范
Java注释书写规范Javadoc是Sun公司提供的一个技术，它从程序源代码中抽取类、方法、成员等注释形成一个和源代码配套的API帮助文档。
也就是说，只要在编写程序时以一套特定的标签作注释，在程序编写完成后，通过Javadoc就可以同时形成程序的开发文档了。
注释注释是指程序中的解释性文字。
这些文字供程序的阅读者查看，编译器将不对其进行编译。
注释能够帮助读者理解程序，并为后续进行测试和维护提供明确的指导信息。
注释要简明，恰到好处，没有注释的代码是糟糕编程习惯的显著标志。
基本原则注释应该增加代码的清晰度。
代码注释的目的是要使代码更易于被其他开发人员等理解。
避免使用装饰性内容。
保持注释的简洁。
注释信息不仅要包括代码的功能，还应给出原因。
不要为注释而注释。
除变量定义等较短语句的注释可用行尾注释外，其他注释应当避免使用行尾注释。
从用途上分，注释可以分为序言性注释和功能性注释。
序言性注释：通称位于程序或者模块的开始部分。
它给出了程序或模块的整体说明，这种描述不包括程序的执行过程细节。
功能性注释：一般嵌入在源程序体之中。
其主要描述某个语句或程序段做什么，执行该语句或程序段会怎样，不是解释怎么做。
只有复杂的执行细节才需要嵌入注释，描述其实现方法。
根据注释符的不同，在java程序中有三种注释。
行注释符“/ / ”编译器会认为以“/ /”开头的字符直至本行末尾都是注释，所以又称行注释。
它一般用于对某条语句或某个变量的注释，以及一些文字不多的注释。
块注释符“/ * ”和“*/ ”“/ * ”和“*/ ”是成对出现的，它们之间的文字都是注释。
这些注释可以分成多行不必再添加行注释符。
文档注释“/ ** ”和“*/ ”文档注释也是一种块注释，它是用来生成帮助文档的。
当程序员编写完程序以后，可以通过JDK提供的javadoc命令，生成所编程序的API文档，而文档中的内容主要就是从文档注释中提取的。
该API文档以HTML文件的形式出现，与java帮助文档的风格及形式完全一致。
intellijidea设置统一JavaDoc模板的方法详解
intellijidea设置统⼀JavaDoc模板的⽅法详解⽬录idea设置统⼀JavaDoc模板设置普通注释⾃定义模板⽅法注释类名注释idea设置统⼀JavaDoc模板设置普通注释按照如下导航找到位置：Setting > Editor > File and Code Templates > Includes > File Header复制如下，即可实现简单的JavaDoc注释/*** @author : ChenLiWu* @date : ${DATE} ${TIME}*/⾃定义模板⽅法注释按照如下导航找到位置：Setting > Editor > Live Templates看到右边的 + 按钮，选择第⼆项 2. Template Group… Group 名字随便定义增加好 Group 之后，点击选中⾃⼰添加的 Group，再点击右边的**+**选择第⼀项 1. Live Template按照下图设置，*** description: $description$$params$* @return $return$* @throws $throws$* @author ChenLiwu* @date $date$ $time$*/其中params对应的是⽤脚本写的：groovyScript("def result=''; def stop=false; def params=\"${_1}\".replaceAll('[\\\\[|\\\\]|\\\\s]', '').split(',').toList(); if (params.size()==1 && (params[0]==null || params[0]=='null' || params[0]=='')) { stop=true; }; if(!stop) { for(i = 0; i < params.size(); i++) {result+=' * @par类名注释同理：*** description: $description$* @author ChenLiwu* @version 1.0* @date $date$ $time$*/这样⼀来“/” + 你的快捷触发键 + 快捷⽣成按钮即可⼀键⽣成你要的javadoc模板注释到此这篇关于intellij idea设置统⼀JavaDoc模板的⽂章就介绍到这了,更多相关idea JavaDoc模板内容请搜索以前的⽂章或继续浏览下⾯的相关⽂章希望⼤家以后多多⽀持！。
Annotation深入研究——@Documented注释使用
Annotation深入研究 ——@Documented注释使用
Documented注释的作用及其javadoc文档生成工具的使用 代码放在MyDocumentedtAnnotationDemo.java文件中 package org.yu.demo16.documentedannotation ; import ng.annotation.Documented ; @MyDocumentedtAnnotation(key="小雨",value="中国地质大学") public class MyDocumentedtAnnotationDemo{
@MyDocumentedtAnnotation(key="小雨",value="中国地质大学") public String toString(){
return "hello yu...பைடு நூலகம் ; } };
@Documented @interface MyDocumentedtAnnotation{
public String key() default "yu" ; public String value() default "cug" ; } 仔细看看下面的编译的结果：
在java文件所在的路径中可以发现生成了doc文件夹，打开文件夹，打开index.html可以发现查看生成的文档 下面是Documented注释用在类上的作用：给类添加注释 下面是Documented注释用在类方法上的作用：给类方法添加注释
- 1、下载文档前请自行甄别文档内容的完整性，平台不提供额外的编辑、内容补充、找答案等附加服务。
- 2、"仅部分预览"的文档,不可在线预览部分如存在完整性等问题,可反馈申请退款(可完整预览的文档不适用该条件!)。
- 3、如文档侵犯您的权益，请联系客服反馈,我们会尽快为您处理(人工客服工作时间：9:00-18:30)。
Javadoc注释说明
Java 文档
// 注释一行
/* ...... */ 注释若干行
/** ...... */ 注释若干行，并写入 javadoc 文档
通常这种注释的多行写法如下：
/**
* .........
* .........
*/
javadoc -d 文档存放目录 -author -version 源文件名.java
这条命令编译一个名为"源文件名.java"的 java 源文件，并将生成的文档存放在"文档存放目录"指定的目录下，生成的文档中 index.html 就是文档的首页。
-author 和 -version 两个选项可以省略。
二. 文档注释的格式
1. 文档和文档注释的格式化
生成的文档是 HTML 格式，而这些 HTML 格式的标识符并不是 javadoc 加的，而是我们在写注释的时候写上去的。
比如，需要换行时，不是敲入一个回车符，而是写入 <br>，如果要分段，就应该在段前写入 <p>。
文档注释的正文并不是直接复制到输出文件 (文档的 HTML 文件)，而是读取每一行后，删掉前导的 * 号及 * 号以前的空格，再输入到文档的。
如
/**
* This is first line. <br>
***** This is second line. <br>
This is third line.
*/
2. 文档注释的三部分
先举例如下
/**
* show 方法的简述.
* <p>show 方法的详细说明第一行<br>
* show 方法的详细说明第二行
* @param b true 表示显示，false 表示隐藏
* @return 没有返回值
*/
public void show(boolean b) {
frame.show(b);
}
第一部分是简述。
文档中，对于属性和方法都是先有一个列表，然后才在后面一个一个的详细的说明
简述部分写在一段文档注释的最前面，第一个点号 (.) 之前 (包括点号)。
换句话说，就是用第一个点号分隔文档注释，之前是简述，之后是第二部分和第三部分。
第二部分是详细说明部分。
该部分对属性或者方法进行详细的说明，在格式上没有什么特殊的要求，可以包含若干个点号。
* show 方法的简述.
* <p>show 方法的详细说明第一行<br>
* show 方法的详细说明第二行
简述也在其中。
这一点要记住了
第三部分是特殊说明部分。
这部分包括版本说明、参数说明、返回值说明等。
* @param b true 表示显示，false 表示隐藏
* @return 没有返回值
三. 使用 javadoc 标记
javadoc 标记由"@"及其后所跟的标记类型和专用注释引用组成
javadoc 标记有如下一些：
@author 标明开发该类模块的作者
@version 标明该类模块的版本
@see 参考转向，也就是相关主题
@param 对方法中某参数的说明
@return 对方法返回值的说明
@exception 对方法可能抛出的异常进行说明
@author 作者名
@version 版本号
其中，@author 可以多次使用，以指明多个作者，生成的文档中每个作者之间使用逗号 (,) 隔开。
@version 也可以使用多次，只有第一次有效
使用 @param、@return 和 @exception 说明方法
这三个标记都是只用于方法的。
@param 描述方法的参数，@return 描述方法的返回值，@exception 描述方法可能抛出的异常。
它们的句法如下：
@param 参数名参数说明
@return 返回值说明
@exception 异常类名说明。