Java文檔註釋用法+JavaDoc的使用說明

Posted on by

簡介

文檔註釋負責描述類、接口、方法、構造器、成員屬性。可以被JDK提供的工具 javadoc 所解析，自動生成一套以網頁文件形式體現該程序說明文檔的註釋。

註意：文檔註釋必須寫在類、接口、方法、構造器、成員字段前面，寫在其他位置無效。

JavaDoc 官方說明

How to Write Doc Comments for the Javadoc Tool

寫在類上面的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> {
}

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

@link：{@link 包名.類名#方法名(參數類型)} 用於快速鏈接到相關代碼

@link的使用語法{@link 包名.類名#方法名(參數類型)}，其中當包名在當前類中已經導入瞭包名可以省略，可以隻是一個類名，也可以是僅僅是一個方法名，也可以是類名.方法名，使用此文檔標記的類或者方法，可用按住Ctrl鍵+鼠標單擊快速跳到相應的類或者方法上，解析成html其實就是使用<code>包名.類名#方法名(參數類型)</code>

@link示例

// 完全限定的類名
{@link java.nio.charset.CharsetEncoder}
// 省略包名
{@link String} and {@link StringBuilder}
// 省略類名，表示指向當前的某個方法
{@link #equals(Object)}
// 包名.類名#方法名(參數類型)
{@link java.lang.Long#toString(long)}

@code： {@code text} 將文本標記為code

@code的使用語法{@code text} 會被解析成<code>text</code>

將文本標記為代碼樣式的文本，在code內部可以使用 < 、> 等不會被解釋成html標簽, 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/" rel="external nofollow"  rel="external nofollow" >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 {}

一般段落都用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, [email protected]
// 超鏈接郵件 純文本作者
@author <a href="mailto:[email protected]" rel="external nofollow" >Ovidiu Predescu</a>
// 純文本郵件
@author [email protected]
// 純文本 組織
@author Apache Software Foundation
// 超鏈接組織地址 純文本組織
@author <a href="https://jakarta.apache.org/turbine" rel="external nofollow" > Apache Jakarta Turbine</a>

@see 另請參閱

@see 一般用於標記該類相關聯的類,@see即可以用在類上，也可以用在方法上。

/**
 * @see IntStream
 * @see LongStream
 * @see DoubleStream
 * @see <a href="package-summary.html" rel="external nofollow" >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 {}

寫在方法上的JavaDoc

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

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

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

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

一般p經常結合pre使用，或者pre結合@code共同使用(推薦@code方式)

一般經常使用pre來舉例如何使用方法

註意：pre標簽中如果有小於號、大於號、例如泛型 在生產javadoc時會報錯

p結合pre使用

/**
 * Check that the given {@code CharSequence} is neither {@code null} nor
 * of length 0.
 * <p>Note: this method returns {@code true} for a {@code CharSequence}
 * that purely consists of whitespace.
 * <p><pre class="code">
 * StringUtils.hasLength(null) = false
 * StringUtils.hasLength("") = false
 * StringUtils.hasLength(" ") = true
 * StringUtils.hasLength("Hello") = true
 * </pre>
 * @param str the {@code CharSequence} to check (may be {@code null})
 * @return {@code true} if the {@code CharSequence} is not {@code null} and has length
 * @see #hasText(String)
 */
public static boolean hasLength(@Nullable CharSequence str) {
	return (str != null && str.length() > 0);
}

pre結合@code使用

<pre>{@code
     Person[] men = people.stream()
                        .filter(p -> p.getGender() == MALE)
                        .toArray(Person[]::new);
}</pre>

@param

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

/**
 * @param str the {@code CharSequence} to check (may be {@code null})
 */
public static boolean hasText(@Nullable CharSequence str) {
 return (str != null && str.length() > 0 && containsText(str));
}

@return

@return 跟返回值的描述

/**
 * @return {@code true} if the {@code CharSequence} is not {@code null},
 * its length is greater than 0, and it does not contain whitespace only
 */
public static boolean hasText(@Nullable CharSequence str) {
 return (str != null && str.length() > 0 && containsText(str));
}

@throws

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

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

@exception

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

package com.sun.jmx.remote.security;
/**
 * @exception LoginException if the logout fails.
 */
public boolean logout() throws LoginException {}

@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 也會被繼承

示例

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/" rel="external nofollow"  rel="external nofollow" >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 {
	/**
	 * Check that the given {@code CharSequence} is neither {@code null} nor
	 * of length 0.
	 * <p>Note: this method returns {@code true} for a {@code CharSequence}
	 * that purely consists of whitespace.
	 * <p><pre class="code">
	 * StringUtils.hasLength(null) = false
	 * StringUtils.hasLength("") = false
	 * StringUtils.hasLength(" ") = true
	 * StringUtils.hasLength("Hello") = true
	 * </pre>
	 * @param str the {@code CharSequence} to check (may be {@code null})
	 * @return {@code true} if the {@code CharSequence} is not {@code null} and has length
	 * @see #hasText(String)
	 */
	public static boolean hasLength(@Nullable CharSequence str) {
		return (str != null && str.length() > 0);
	}
}

親自實踐

package com.example.javadocdemo;
import java.math.BigDecimal;
import java.util.Objects;
/**
 * 類 {@code OrderService} 訂單服務層.
 *
 * <p> 主要包括 創建訂單、取消訂單、查詢訂單等功能更
 *
 * @see Order
 * @author <a href="mailto:[email protected]" rel="external nofollow" >Lerry Li</a>
 * @since 2019/05/06
 */
public class OrderService {
    /** 默認數量 {@value} */
    private static final Integer QUANTITY = 1;
    /**
     * 創建訂單.
     *
     * <p> 創建訂單需要傳用戶id和商品列表(商品id和商品數量).
     *
     * <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 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

通過IDEA生成Javadoc： Tools –> Generate JavaDoc

註意要配置編碼，如果不配置則生成的JavaDoc會亂碼，還需要配置Output directory

Generate JavaDoc

 參數配置

這裡有幾點要特別註意一下：

1、IDEA 的 JavaDoc 生成功能在菜單 Tools->Generate JavaDoc 項裡面。

2、點擊上述菜單項後，會出現生成 JavaDoc 的對話框，一般的選項都很直觀，不必細說。但是要註意生成 JavaDoc 的源代碼對象的選擇，一般以模塊（Module）為主，必要時可以單獨選擇必要的 Java 源代碼文件，不推薦以 Project 為 JavaDoc 生成的源范圍。

3、裡面有一個 Locale 可選填項，表示的是需要生成的 JavaDoc 以何種語言版本展示，根據 javadoc.exe 的幫助說明，這其實對應的就是 javadoc.exe 的 -locale 參數，如果不填，默認可能是英文或者是當前操作系統的語言，既然是國人，建議在此填寫 zh_CN，這樣生成的 JavaDoc 就是中文版本的，當然指的是 JavaDoc 的框架中各種通用的固定顯示區域都是中文的。你自己編寫的註釋轉換的內容還是根據你註釋的內容來。

4、還有一個“Other command line arguments:”可選填項，非常重要，是填寫直接向 javadoc.exe 傳遞的參數內容。因為有一些重要的設置，隻能通過直接參數形式向 javadoc.exe 傳遞。這裡必須要填寫如下參數：

-encoding UTF-8 -charset UTF-8 -windowtitle “JavaDoc使用詳解” -link https://docs.oracle.com/javase/8/docs/api

5、第一個參數 -encoding UTF-8 表示你的源代碼（含有符合 JavaDoc 標準的註釋）是基於 UTF-8 編碼的，以免處理過程中出現中文等非英語字符亂碼；第二個參數 -charset UTF-8 表示在處理並生成 JavaDoc 超文本時使用的字符集也是以 UTF-8 為編碼，目前所有瀏覽器都支持 UTF-8，這樣最具有通用性，支持中文非常好；第三個參數 -windowtitle 表示生成的 JavaDoc 超文本在瀏覽器中打開時，瀏覽器窗口標題欄顯示的文字內容；第四個參數 -link 很重要，它表示你生成的 JavaDoc 中涉及到很多對其他外部 Java 類的引用，是使用全限定名稱還是帶有超鏈接的短名稱

舉個例子，我創建瞭一個方法 public void func(String arg)，這個方法在生成 JavaDoc 時如果不指定 -link 參數，則 JavaDoc 中對該方法的表述就會自動變為 public void func(java.lang.String arg)，因為 String 這個類對我自己實現的類來講就是外部引用的類，雖然它是 Java 標準庫的類。如果指定瞭 -link https://docs.oracle.com/javase/8/docs/api/ 參數，則 javadoc.exe 在生成 JavaDoc 時，會使用 String 這樣的短名稱而非全限定名稱 java.lang.String，同時自動為 String 短名稱生成一個超鏈接，指向官方 JavaSE 標準文檔 https://docs.oracle.com/javase/8/docs/api/ 中對 String 類的詳細文檔地址。

-link 實質上是告訴 javadoc.exe 根據提供的外部引用類的 JavaDoc 地址去找一個叫 package-list 的文本文件，在這個文本文件中包含瞭所有外部引用類的全限定名稱，因此生成的新 JavaDoc 不必使用外部引用類的全限定名，隻需要使用短名稱，同時可以自動創建指向其外部引用 JavaDoc 中的詳細文檔超鏈接。

每個 JavaDoc 都會在根目錄下有一個 package-list 文件，包括我們自己生成的 JavaDoc。

查看成果

配置完畢後點擊OK按鈕,console看到如下日志輸出則說明JavaDoc生成成功

生成JavaDoc

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

生成後的JavaDoc

類結構

方法資料

以上為個人經驗，希望能給大傢一個參考，也希望大傢多多支持WalkonNet。

推薦閱讀：