JAVADOC


JAVADOC

简介

Javadoc用于描述类或者方法的作用

Javadoc用于描述类或者方法的作用

  • 第一段:概要描述,通常用一句或者一段话简要描述该类的作用,以英文句号作为结束
  • 第二段:详细描述,通常用一段或者多段话来详细描述该类的作用,一般每段话都以英文句号作为结束
  • 第三段:文档标注,类上用于标注作者、创建时间、参阅类等信息,方法上用于标注参数、返回值、异常、参阅等

常用标记

类上
  • 概要描述
  1. @link:{@link 包名.类名#方法名(参数类型)} 用于快速链接到相关代码

    @link的使用语法{@link 包名.类名#方法名(参数类型)},其中当包名在当前类中已经导入了包名可以省略,

    可以只是一个类名,也可以是仅仅是一个方法名(或#方法名),也可以是类名.方法名,使用此文档标记的类或者方,

    可用通过按住Ctrl键+单击 可以快速跳到相应的类或者方法上,解析成html其实就是使用< code> 包名.类名#方法名(参数类型)< /code>

  2. @code: {@code text} 将文本标记为code

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

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

  1. @param

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

  2. @author

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

  3. @see 另请参阅

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

  4. @since 从以下版本开始

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

  5. @version 版本

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

方法上

方法详细描述上经常使用html标签来,通常都以p标签开始,而且p标签通常都是单标签,不使用结束标签,其中使用最多的就是p标签和pre标签,ul标签, i标签。

pre元素可定义预格式化的文本。被包围在pre元素中的文本通常会保留空格和换行符。而文本也会呈现为等宽字体,pre标签的一个常见应用就是用来表示计算机的源代码。

一般p经常结合pre使用,或者pre结合@code共同使用(推荐@code方式)
一般经常使用pre来举例如何使用方法

注意:

标签中如果有小于号、大于号、例如泛型 在生产javadoc时会报错(如有需要,结合{@Code}一起使用)

  1. @param

@param 后面跟参数名,再跟参数描述

  1. @return

    @return 跟返回值的描述

  2. @throws

    @throws 跟异常类型 异常描述 , 用于描述方法内部可能抛出的异常

  3. @exception

    用于描述方法签名throws对应的异常

  4. @see

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

  5. @value

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

  1. @inheritDoc

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

示例

package org.springframework.util;

/**
 * Miscellaneous {@link String} utility methods.
 *
 * 

Mainly for internal use within the framework; consider * Apache's Commons Lang * for a more comprehensive suite of {@code String} utilities. * *

This class delivers some simple functionality that should really be * provided by the core Java {@link String} and {@link StringBuilder} * classes. It also provides easy-to-use methods to convert between * delimited strings, such as CSV strings, and collections and arrays. * * @author Rod Johnson * @author Juergen Hoeller * @author Keith Donald * @author Rob Harrop * @author Rick Evans * @author Arjen Poutsma * @author Sam Brannen * @author Brian Clozel * @since 16 April 2001 */ public abstract class StringUtils { /** * Decode the given encoded URI component value. Based on the following rules: *

    *
  • Alphanumeric characters {@code "a"} through {@code "z"}, {@code "A"} through {@code "Z"}, * and {@code "0"} through {@code "9"} stay the same.
  • *
  • Special characters {@code "-"}, {@code "_"}, {@code "."}, and {@code "*"} stay the same.
  • *
  • A sequence "{@code %xy}" is interpreted as a hexadecimal representation of the character.
  • *
* * @param source the encoded String * @param charset the character set * @return the decoded value * @throws IllegalArgumentException when the given source contains invalid encoded sequences * @since 5.0 * @see java.net.URLDecoder#decode(String, String) */ public static String uriDecode(String source, Charset charset) {} }
package com.example.demo;

/**
 * 类 {@code OrderService} 订单服务层.
 *
 * 

主要包括 创建订单、取消订单、查询订单等功能更 * * @see Order * @author Mengday Zhang * @since 2018/5/12 */ public class OrderService { /** 默认数量 {@value} */ private static final Integer QUANTITY = 1; /** * 创建订单. * *

创建订单需要传用户id和商品列表(商品id和商品数量). * *

{@code
     *  演示如何使用该方法
     *  List items = new ArrayList<>();
     *  Goods goods = new Goods(1L, BigDecimal.ONE);
     *  Goods goods2 = new Goods(2L, BigDecimal.TEN);
     *  items.add(goods);
     *  items.add(goods2);
     *
     *  Order order1 = new Order();
     *  order.setUserId("1");
     *  order.setItems(items);
     *  OrderService#createOrder(order);
     * }
     * 
* * @param order 订单信息 * @throws NullPointerException 参数信息为空 * @exception IllegalArgumentException 数量不合法 * @return 是否创建成功 * @version 1.0 * @see {@link Order} */ public boolean createOrder(Order order) throws IllegalArgumentException{ Objects.requireNonNull(order); List items = order.getItems(); items.forEach(goods -> { BigDecimal quantity = goods.getQuantity(); if (quantity == null || BigDecimal.ZERO.compareTo(quantity) == 0) { throw new IllegalArgumentException(); } }); System.out.println("create order..."); return true; } }