Java Doc--文档注释的用法

原文网址：Java Doc--文档注释的用法-CSDN博客

简介

说明

本文介绍Java Doc（文档注释）的用法。

官网

https://docs.oracle.com/javase/7/docs/technotes/tools/windows/javadoc.html

Java Doc注解

写在类上面的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 java.lang;
/**
 * 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> {
}

@link

作用

用于快速跳转到相关代码

用法

{@link 包名.类名#方法名(参数类型)} 

        当包名在当前类中已经导入了包名可以省略。

        可以只是一个类名，也可以是仅仅是一个方法名，也可以是类名.方法名。

        使用此文档标记的类或者方法，可用按住Ctrl键+鼠标单击快速跳到相应的类或者方法上。

        解析成html其实就是使用包名.类名#方法名(参数类型)

示例

// 完全限定的类名
{@link java.nio.charset.CharsetEncoder}

// 省略包名
{@link String} and {@link StringBuilder}

// 省略类名，表示指向当前的某个方法
{@link #equals(Object)}

// 包名.类名#方法名(参数类型)
{@link java.lang.Long#toString(long)} 

@code

作用

        将文本标记为code，这样会被解析成text。

        将文本标记为代码样式的文本，在code内部可以使用 < 、> 等不会被解释成html标签, code标签有自己的样式。

        一般在Javadoc中只要涉及到类名或者方法名，都需要使用@code进行标记。

用法

{@code text}

第二段：详细描述

        详细描述一般用一段或多段来详细描述类的作用，详细描述中可以使用html标签，如下：

详细描述和概要描述中间通常有一个空行来分割， 实例如下

第三段：文档标注

上边是文章的部分内容，为统一维护，全文已转移到此网址：Java Doc-文档注释的用法 - 自学精灵