很多程式對Javadoc都不重視，認識不到Javadoc的作用，很多人都是這樣認為的：“我只要寫好功能就夠了，寫Javadoc太浪費時間，也沒啥作用，還不如用寫Javadoc的時間再多些個功能呢！”，我們知道註釋是為了解釋程式碼的作用的，是為了將來給自己或者別人快速瞭解程式碼的，在方法內一般用行註釋//的比較多，是針對一小塊程式碼做出解釋的，而Javadoc的作用是針對整個方法或者整個類做一個簡要的概述的，使得別人不通過看具體方法程式碼就能知道某個方法或者某個類的作用和功能。寫了Javadoc的在別人使用到類時，將滑鼠懸停到類上或者方法上，javadoc會以提示資訊顯示出來，這樣開發者在跳進原始碼中就能知道類或者方法的作用。說到這裡可能還是有很多人不能認同這種觀點，還是認識不到Javadoc的作用。我們看一下Spring框架，隨便開啟一個檔案可以看到一般註釋內容都要比程式碼量多，有的時候註釋量佔整個檔案內容的2/3。有人還是認為Spring是大框架，每個Java專案都在用他們寫的好事應該的，我們公司自己的專案就我們公司幾個人看，沒必要花時間去寫多餘的Javadoc，那你是不是該這麼認為了Spring大廠中的頂尖大牛都這麼做，我們小菜鳥是不是對自己要求更嚴格一些，向大牛去學習呢？！假如在公司A程式設計師寫了Javadoc，B程式設計師只寫功能不寫Javadoc不寫註釋，那麼一般會認為A程式設計師會比B程式設計師做的好。認識不到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等。

1. @link：{@link 包名.類名#方法名(引數型別)} 用於快速連結到相關程式碼

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

@link示例

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

// 省略包名
{@link String}

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

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

2. @code： {@code text} 將文字標記為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.
 *
 */
public abstract class StringUtils {

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

3. @param

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

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

4. @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>

5. @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>> {}

6. @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 {}

7. @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來舉例如何使用方法

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

/**
 * 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));
}

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

8. @param

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

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

9. @return

@return 跟返回值的描述

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

10. @throws

@throws 跟異常型別 異常描述,用於描述方法內部可能丟擲的異常

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

11. @exception

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

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

12. @see

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

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

13. @value

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

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

14. @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,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:[email protected]" rel="external nofollow" >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

idea生成javadoc https://www.jb51.net/article/192943.htm

通過IDEA生成Javadoc： Tools --> Generate JavaDoc -->
注意要配置編碼，如果不配送為生成亂碼，還需要配置Output directory

到此這篇關於Javadoc 具體使用詳解的文章就介紹到這了,更多相關Javadoc 使用內容請搜尋我們以前的文章或繼續瀏覽下面的相關文章希望大家以後多多支援我們！