Javadoc 注釋使用詳解

引言

很多程序員對 Javadoc都不重視，認識不到 Javadoc 的作用，很多人都是這樣認為的：“我只要寫好功能就夠了，寫 Javadoc 太浪費時間，也沒啥作用，還不如用寫 Javadoc 的時間再多些個功能呢！”。

我們知道注釋是為了解釋代碼的作用的，是為了將來給自己或者別人快速了解代碼的，在方法內一般用行注釋//的比較多，是針對一小塊代碼做出解釋的，而 Javadoc 的作用是針對整個方法或者整個類做一個簡要的概述的，使得別人不通過看具體方法代碼就能知道某個方法或者某個類的作用和功能。

寫了 Javadoc 的在別人使用到類時，將鼠標懸停到類上或者方法上，javadoc 會以提示信息顯示出來，這樣開發者在跳進源代碼中就能知道類或者方法的作用。

簡介

Javadoc 用於描述類或者方法的作用。Javadoc 可以寫在類上面和方法上面。

官網描述：https://docs.oracle.com/javase/7/docs/technotes/tools/windows/javadoc.html

寫在類上面的 Javadoc

寫在類上的文檔標注一般分為三段：

• 第一段：概要描述，通常用一句或者一段話簡要描述該類的作用，以英文句號作為結束
• 第二段：詳細描述，通常用一段或者多段話來詳細描述該類的作用，一般每段話都以英文句號作為結束
• 第三段：文檔標注，用於標注作者、創建時間、參閱類等信息

第一段：概要描述

單行示例：

package org.springframework.util;

/**
 * Miscellaneous {@link String} utility methods.
 * 
 */
public abstract class StringUtils {}

多行示例：

package java.lang;

/**
 * Class {@code Object} is the root of the class hierarchy.
 * Every class has {@code Object} as a superclass. All objects,
 * including arrays, implement the methods of this class.
 */
public class Object {}

在注釋中出現以@開頭東西被稱之為Javadoc文檔標記，是JDK定義好的，如@author、@version、@since、@see、@link、@code、@param、@return、@exception、@throws等。

@link

• 使用語法：{@link 包名.類名#方法名(參數類型)}

• 標記作用：用於快速鏈接到相關代碼

@link示例：

// 完全限定的類名
{@link java.lang.Character}

// 省略包名
{@link String}

// 省略類名，表示指向當前的某個方法
{@link #length()}

// 包名.類名.方法名(參數類型)
{@link java.lang.String#charAt(int)}

@code：

• 使用語法：{@code text}
• 標記作用： 將文本標記為 code

一般在Javadoc中只要涉及到類名或者方法名，都需要使用@code進行標記。

第二段：詳細描述

詳細描述一般用一段或者幾個鍛煉來詳細描述類的作用，詳細描述中可以使用html標簽，如<p>、<pre>、<a>、<ul>、<i>等標簽， 通常詳細描述都以段落p標簽開始。
詳細描述和概要描述中間通常有一個空行來分割

package org.springframework.util;

/**
 * Miscellaneous {@link String} utility methods.
 *
 * <p>Mainly for internal use within the framework; consider
 * <a href="http://commons.apache.org/proper/commons-lang/">Apache's Commons Lang</a>
 * for a more comprehensive suite of {@code String} utilities.
 *
 * <p>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.
 *
 */
public abstract class StringUtils {}

一般段落都用p標簽來標記，凡涉及到類名和方法名都用@code標記，凡涉及到組織的，一般用a標簽提供出來鏈接地址。

@param

一般類中支持泛型時會通過@param來解釋泛型的類型

/**
* @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, [e-mail]

// 超鏈接郵件 純文本作者
@author <a href="mailto:[e-mail]">Ovidiu Predescu</a>

// 純文本郵件
@author [e-mail]

// 純文本 組織
@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 Resolver extends Catalog {}

寫在方法上的Javadoc

寫在方法上的文檔標注一般分為三段：

• 第一段：概要描述，通常用一句或者一段話簡要描述該方法的作用，以英文句號作為結束
• 第二段：詳細描述，通常用一段或者多段話來詳細描述該方法的作用，一般每段話都以英文句號作為結束
• 第三段：文檔標注，用於標注參數、返回值、異常、參閱等

方法詳細描述上經常使用 html 標簽來，通常都以 p 標簽開始，而且p標簽通常都是單標簽，不使用結束標簽，其中使用最多的就是p標簽和pre標簽,ul標簽, i標簽。

pre 元素可定義預格式化的文本。被包圍在pre元素中的文本通常會保留空格和換行符。而文本也會呈現為等寬字體，pre標簽的一個常見應用就是用來表示計算機的源代碼。

一般p經常結合pre使用，或者pre結合@code共同使用(推薦@code方式)
一般經常使用pre來舉例如何使用方法

/**
 * Check whether the given {@code CharSequence} contains actual <em>text</em>.
 * <p>More specifically, this method returns {@code true} if the
 * {@code CharSequence} is not {@code null}, its length is greater than
 * 0, and it contains at least one non-whitespace character.
 * <p><pre class="code">
 * StringUtils.hasText(null) = false
 * StringUtils.hasText("") = false
 * StringUtils.hasText(" ") = false
 * StringUtils.hasText("12345") = true
 * StringUtils.hasText(" 12345 ") = true
 * </pre>
 * @param str the {@code CharSequence} to check (may be {@code null})
 * @return {@code true} if the {@code CharSequence} is not {@code null},
 * its length is greater than 0, and it does not contain whitespace only
 * @see Character#isWhitespace
 */
public static boolean hasText(@Nullable CharSequence str) {
	return (str != null && str.length() > 0 && containsText(str));
}

@param

@param 后面跟參數名，再跟參數描述

/**
* @param str the {@code CharSequence} to check (may be {@code null})
*/
public static boolean containsWhitespace(@Nullable CharSequence str) {}

@return

@return 跟返回值的描述

/**
* @return {@code true} if the {@code String} is not {@code null}, its
*/
public static boolean hasText(@Nullable String str){}

@throws

@throws 跟異常類型 異常描述 , 用於描述方法內部可能拋出的異常

/**
* @throws IllegalArgumentException when the given source contains invalid encoded sequences
*/
public static String uriDecode(String source, Charset charset){}

@exception

@exception 用於描述方法簽名throws對應的異常

/**
* @exception IllegalArgumentException if <code>key</code> is null.
*/
public static Object get(String key) throws IllegalArgumentException {}

@see

@see既可以用來類上也可以用在方法上，表示可以參考的類或者方法

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

@value

@value 用於標注在常量上，{@value} 用於表示常量的值

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

@inheritDoc

@inheritDoc用於注解在重寫方法或者子類上，用於繼承父類中的Javadoc

• 基類的文檔注釋被繼承到了子類
• 子類可以再加入自己的注釋（特殊化擴展）
• @return @param @throws 也會被繼承

Javadoc 使用示例

spring-core中的StringUtils 示例

package org.springframework.util;

/**
 * Miscellaneous {@link String} utility methods.
 *
 * <p>Mainly for internal use within the framework; consider
 * <a href="http://commons.apache.org/proper/commons-lang/">Apache's Commons Lang</a>
 * for a more comprehensive suite of {@code String} utilities.
 *
 * <p>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:
	 * <ul>
	 * <li>Alphanumeric characters {@code "a"} through {@code "z"}, {@code "A"} through {@code "Z"},
	 * and {@code "0"} through {@code "9"} stay the same.</li>
	 * <li>Special characters {@code "-"}, {@code "_"}, {@code "."}, and {@code "*"} stay the same.</li>
	 * <li>A sequence "{@code %<i>xy</i>}" is interpreted as a hexadecimal representation of the character.</li>
	 * </ul>
	 * 
	 * @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} 訂單服務層.
 *
 * <p> 主要包括 創建訂單、取消訂單、查詢訂單等功能更
 *
 * @see Order
 * @author <a href="mailto:[e-mail]">Mengday Zhang</a>
 * @since 2018/5/12
 */
public class OrderService {

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

    /**
     * 創建訂單.
     *
     * <p> 創建訂單需要傳用戶id和商品列表(商品id和商品數量).
     *
     * <p><pre>{@code
     *  演示如何使用該方法
     *  List<Goods> 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);
     * }
     * </pre>
     *
     * @param order 訂單信息
     * @throws NullPointerException 參數信息為空
     * @exception IllegalArgumentException  數量不合法
     * @return 是否創建成功
     * @version 1.0
     * @see {@link Order}
     */
    public boolean createOrder(Order order) throws IllegalArgumentException{
        Objects.requireNonNull(order);

        List<Goods> 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;
    }
}

生成Javadoc

使用 JDK 原生 javadoc.exe 工具生成 Javadoc 文檔

在編寫完成 java 程序中的文檔注釋后，可以使用 javadoc工具 提取程序中的文檔注釋來生成API文檔

添加 Javadoc 注解的 HelloWorld.java 源文件如下：

/**
 * @author binge
 * @desc 第一個 Java 程序
 * @date 2021/7/13 15:12
 */
public class HelloWorld {
    /**
     * 入口 main 方法
     * @param args 運行時傳入的數組參數
     */
    public static void main(String[] args) {
        System.out.println("Hello,world!");
    }
}

生成 Javadoc 命令如下：

C:\Users\binge\Desktop\Java> javadoc -d apidoc -windowtitle testapi -doctitle test -header binge HelloWorld.java

• -d < directory > ：該選項指定一個路徑，用於將生成的 API 文檔放到指定目錄下
• -windowtitle < text > : 該選項指定一個字符串，用於設置 API 文檔的瀏覽器窗口標題
• -doctitle < html-code > : 該選項指定一個HTML格式的文本，用於指定概述頁面的標題。（只對有處於多個包下的源文件來生成API文檔時，才有概述頁面）
• -header < html-code > : 該選項指定一個HTML格式的文本，包含每個頁面的頁眉

使用 IDEA 生成 Javadoc 文檔

• IDEA 的 JavaDoc 生成功能在菜單 Tools->Generate JavaDoc 項里面

• 點擊上述菜單項后，會出現生成 JavaDoc 的對話框，一般的選項都很直觀，不必細說。

  

  • 要注意生成 JavaDoc 的源代碼對象的選擇，一般以模塊（Module）為主，必要時可以單獨選擇必要的 Java 源代碼文件，不推薦以 Project 為 JavaDoc 生成的源范圍

  • 里面有一個 Locale 可選填項，表示的是需要生成的 JavaDoc 以何種語言版本展示，根據 javadoc.exe 的幫助說明，這其實對應的就是 javadoc.exe 的 -locale 參數，如果不填，默認可能是英文或者是當前操作系統的語言，建議在此填寫 zh_CN，這樣生成的 JavaDoc 就是中文版本的

  • 還有一個“Other command line arguments:”可選填項，非常重要，是填寫直接向 javadoc.exe 傳遞的參數內容，這里必須要填寫如下參數：

    -encoding UTF-8 -charset UTF-8 -windowtitle "javadoc" -link http://docs.oracle.com/javase/7/docs/api

    • -encoding UTF-8 ：表示你的源代碼（含有符合 JavaDoc 標准的注釋）是基於 UTF-8 編碼的，以免處理過程中出現中文等非英語字符亂碼；
    • -charset UTF-8 ：表示在處理並生成 JavaDoc 超文本時使用的字符集也是以 UTF-8 為編碼，目前所有瀏覽器都支持 UTF-8，這樣最具有通用性，支持中文非常好
    • -windowtitle ：表示生成的 JavaDoc 超文本在瀏覽器中打開時，瀏覽器窗口標題欄顯示的文字內容；
    • -link ：它表示你生成的 JavaDoc 中涉及到很多對其他外部 Java 類的引用，是使用全限定名稱還是帶有超鏈接的短名稱。-link 實質上是告訴 javadoc.exe 根據提供的外部引用類的 JavaDoc 地址去找一個叫 package-list 的文本文件，在這個文本文件中包含了所有外部引用類的全限定名稱，因此生成的新 JavaDoc 不必使用外部引用類的全限定名，只需要使用短名稱，同時可以自動創建指向其外部引用 JavaDoc 中的詳細文檔超鏈接。每個 JavaDoc 都會在根目錄下有一個 package-list 文件，包括我們自己生成的 JavaDoc。

  • JavaDoc 生成完畢，即可在其根目錄下找到 index.html 文件，打開它就可以看到我們自己的標准 JavaDoc API 文檔