`
fantaxy025025
  • 浏览: 1327504 次
  • 性别: Icon_minigender_1
  • 来自: 北京
社区版块
存档分类

【摘】Java文档注释用法+JavaDoc的使用详解

 
阅读更多

=

=

 

节约重复注释

使用@inheritDoc  

使用@see

 

=

 

Java文档注释用法+JavaDoc的使用详解

文档注释负责描述类、接口、方法、构造器、成员属性。可以被JDK提供的工具 javadoc 所解析,自动生成一套以网页文件形式体现该程序说明文档的注释。

注意:文档注释必须写在类、接口、方法、构造器、成员字段前面,写在其他位置无效。

JavaDoc 官方说明
How to Write Doc Comments for the Javadoc Tool

 

原文:https://blog.csdn.net/lsy0903/article/details/89893934

 

一般段落都用p标签来标记,凡涉及到类名和方法名都用@code标记,凡涉及到组织的,一般用a标签提供出来链接地址。

@param

一般类中支持泛型时会通过@param来解释泛型的类型

package java.util;
/**
 * @param <E> the type of elements in this list
 *
 */
public interface List<E> extends Collection<E> {}

@author

详细描述后面一般使用@author来标记作者,如果一个文件有多个作者来维护就标记多个@author@author后面可以跟作者姓名(也可以附带邮箱地址)、组织名称(也可以附带组织官网地址)

// 纯文本作者
@author Rod Johnson

// 纯文本作者,邮件
@author Igor Hersht, igorh@ca.ibm.com

// 超链接邮件 纯文本作者
@author <a href="mailto:ovidiu@cup.hp.com">Ovidiu Predescu</a>

// 纯文本邮件
@author shane_curcuru@us.ibm.com

// 纯文本 组织
@author Apache Software Foundation

// 超链接组织地址 纯文本组织
@author <a href="https://jakarta.apache.org/turbine"> Apache Jakarta Turbine</a>

@see 另请参阅

@see 一般用于标记该类相关联的类,@see即可以用在类上,也可以用在方法上。

/**
 * @see IntStream
 * @see LongStream
 * @see DoubleStream
 * @see <a href="package-summary.html">java.util.stream</a>
 * /
public interface Stream<T> extends BaseStream<T, Stream<T>> {}

@since 从以下版本开始

@since 一般用于标记文件创建时项目当时对应的版本,一般后面跟版本号,也可以跟是一个时间,表示文件当前创建的时间

package java.util.stream;

/**
* @since 1.8
*/
public interface Stream<T> extends BaseStream<T, Stream<T>> {}
package org.springframework.util;

/**
* @since 16 April 2001
*/
public abstract class StringUtils {}

@version 版本

@version用于标记当前版本,默认为1.0

 package com.sun.org.apache.xml.internal.resolver;
 /**
 * @version 1.0
 */
public class CatalogManager {}

 

 

@deprecated

@deprecated 用于标注一个类或成员已过期,通常配合{@link}使用

/**
* @deprecated as of 5.0.4, in favor of {@link Locale#toLanguageTag()}
*/
@Deprecated
public static String toLanguageTag(Locale locale) {
return locale.getLanguage() + (hasText(locale.getCountry()) ? "-" + locale.getCountry() : "");
}

@see

@see 既可以用来类上也可以用在方法上,表示可以参考的类或者方法

/**
* @see java.net.URLDecoder#decode(String, String)
*/
public static String uriDecode(String source, Charset charset) {}

@value

{@value} 用于标注在常量上用于表示常量的值

/** 默认数量 {@value} */
private static final Integer QUANTITY = 1;

@inheritDoc

@inheritDoc 用于注解在重写方法或者子类上,用于继承父类中的Javadoc

  • 基类的文档注释被继承到了子类
  • 子类可以再加入自己的注释(特殊化扩展)
  • @return @param @throws 也会被继承

 

 

原文:https://blog.csdn.net/lsy0903/article/details/89893934

 

=

=

=

 

分享到:
评论

相关推荐

    java编码规范及注释快捷键.doc

    - **文档注释**:用于生成API文档,通常采用Javadoc格式,位于类或方法声明之前。 - **实现注释**:补充说明类或接口的实现细节,对于理解代码背后的逻辑至关重要。 - **方法注释快捷键**:IDEs如Eclipse或IntelliJ ...

    java文档注释要求

    ### Java文档注释要求详解 #### 一、引言 在软件开发领域,编写高质量的代码不仅是技术实力的体现,更是职业素养的重要标志之一。其中,文档注释(JavaDoc Comments)作为源代码的一部分,对于提升项目的可维护性...

    java注释规范文档

    本文详细介绍了Java文档注释的规范及其重要性。通过遵循这些规范,不仅可以提高代码的可读性和可维护性,还能极大地提高团队的开发效率。掌握好javadoc工具的使用,能够帮助我们轻松地生成高质量的文档,这对于大型...

    Java帮助文档的使用方法

    ### Java帮助文档的使用方法详解 #### 一、引言 在Java开发过程中,为了更好地理解和维护代码,以及方便其他开发者阅读,我们需要为项目编写详尽的文档。Java帮助文档是一种重要的工具,它可以帮助我们从源代码中...

    java5.0注释详解

    在这个版本中,注释的使用得到了显著的扩展,引入了类型注释、文档注释的改进以及元注释的使用,这些都在提升代码的维护性和可读性方面起到了关键作用。 1. **类型注解(Type Annotations)** Java 5引入了类型...

    详解IDEA自定义注释模板(javadoc)

    IDEA自定义注释模板(javadoc)是指在IntelliJ IDEA中自定义Java文档注释模板,以满足项目的编码风格和需求。本文将介绍两种自定义注释模板的解决方案:安装Jindent插件和使用IDEA自带的Live Template模板设置。 一、...

    java代码注释规范文档

    ##### 2.3 文档注释(Javadoc) - **格式**:`/** 文档注释内容 */` - **应用场景**: - 为类、方法、字段等提供详细说明。 - 自动生成API文档。 **示例**: ```java /** * 这是一个示例类,用于演示Javadoc...

    Javadoc 具体使用详解

    Javadoc 是 Java 语言中一种文档生成工具,它可以将 Java 代码中的注释转换为 HTML 格式的文档,从而方便程序员在使用类库或框架时可以快速地了解类或方法的作用和功能。下面是 Javadoc 的具体使用详解: Javadoc ...

    如何编写java文档

    本教程将深入讲解如何有效地使用Javadoc来编写高质量的Java文档。 一、Javadoc注释语法 1. 类注释:在类定义的上方,使用`/** ... */`包裹注释内容,例如: ```java /** * 这里是对整个类的描述,包括它的功能、...

    java基础PDF文档

    - 使用方法示例: ```bash javadoc -d docDir -sourcepath srcDir MyClass.java ``` 其中`-d docDir`指定输出文档的目录,`-sourcepath srcDir`指定源代码的路径。 #### 三、注释的实践价值 1. **提高代码...

    Eclipse Java注释模板.txt

    ### Eclipse Java注释模板知识点详解 #### 一、概述 在进行Java开发的过程中,良好的代码注释习惯不仅能帮助自己快速回顾代码逻辑,还能方便其他开发者理解代码意图,从而提高整个团队的工作效率。Eclipse作为一款...

    Javadoc详细讲解以及生成方式

    **Javadoc详解与生成方法** Javadoc是一种在Java编程语言中用于生成API文档的工具,它能够自动提取源代码中的注释,形成清晰、结构化的文档,方便开发者理解和使用代码库。本文将深入探讨Javadoc的基本概念、语法、...

    Maven在Java8下如何忽略Javadoc的编译错误详解

    在Java开发中,JavaDoc是一种重要的工具,它能够自动生成项目的API文档,提供类、方法、接口等的详细说明。然而,在使用Java8时,Maven的JavaDoc插件(maven-javadoc-plugin)对JavaDoc的语法检查变得更加严格,有时...

    Eclipse Java注释模板设置详解

    这篇博文“Eclipse Java注释模板设置详解”将带你深入了解如何通过调整Eclipse的配置来创建和使用个性化的Java代码注释模板。这个过程不仅能够提高开发效率,还能保持代码的一致性和专业性。 首先,让我们来看看...

    java网络编程基础习题+部分答案

    - Java 文档注释(javadoc 注释)使用 `/** ... */` 形式,在注释中可以包含 @ 标签来描述类、方法等的用途和参数等信息。javadoc 工具可以自动生成 HTML 格式的文档。例如: ```java /** * 描述类的功能 * @...

    Java软件开发实战 Java基础与案例开发详解 2-4 java类库组织结构和文档 共9页.pdf

    - **Java API 文档**:Java API 文档是对这些预定义类及其方法、属性等进行详细说明的文档,对于理解如何使用这些类至关重要。 ### 3. Java API 文档的生成与使用 - **javadoc 工具**:javadoc 是一个用于生成HTML...

    java 2语言命令详解

    Java 2语言命令详解 Java 2平台是Java技术的核心组成部分,它提供了广泛的功能和工具,使得开发者能够创建、编译、运行Java应用程序。在Java 2中,有一系列的命令行工具,它们是开发过程中的重要环节。下面将详细...

    Javadoc转换chm帮助文档的四种方法总结

    ### Javadoc转换CHM帮助文档的四种方法详解 #### 关键词 - Javadoc - CHM转换 - JD2CHM - JAVADOC2CHM - JAVADOC2HELP - JAVADOC2CHM项目 - 中文乱码 #### 前言 在软件开发过程中,编写清晰、准确的文档是非常重要...

    java基础知识思考题+答案(个人整理)

    ### Java基础知识思考...- 文档注释(/** */):用于生成文档,通常包含在方法、类等的上方,可以被Javadoc工具提取生成文档。 这些知识点涵盖了Java基础知识的重要方面,对于初学者和有一定经验的开发者都非常有用。

Global site tag (gtag.js) - Google Analytics