Java 套件管理與 Javadoc 文檔生成完整指南：從標準包到自訂包實作

什麼是套件？

Java 套件實質對應目錄結構，用於組織管理類別與介面。引用時使用 import 關鍵字，如 import java.util.*; 引入該套件所有公有類別。

常用 JDK 標準套件速查

自訂套件建立步驟

1. 定義 public 類別。
2. 檔案首行宣告 package 套件名;（如 package com.chen.test;）。
3. 編譯時指定輸出根目錄：javac -d C:\ B.java，自動產生 C:\com\chen\test\B.class。
4. 將根目錄 C:\ 加入環境變數 CLASSPATH。

呼叫自訂套件

// A.java
import com.chen.test.*;
public class A {
    public static void main(String[] args) {
        B test = new B();
        test.add(6, 8);  // 輸出 14
    }
}

編譯 javac C:\A.java，執行 java A。注意：來源檔 A.java 與 B.java 不可置於同目錄，否則編譯衝突。

Javadoc：生成專業 API 文檔

註解標籤分類

• 獨立標籤：@author、@version、@param、@return、@see、@throws 等。
• 內聯標籤：{@link package.class#member label}，在註解中建立超連結。

範例程式碼

/**
 * 我的 JavaDoc 測試程序--<b>JavaDocTest</b>
 * @author <a href="https://www.csdn.net">warton2003 西安</a>
 * <br><font color=red>test</font><!-- HTML 註釋 -->
 * @version 0.1 2004/01/01
 */
public class JavaDocTest {
    /** 在 main() 中要使用字符串 @see #main(java.lang.String) */
    static String SDisplay;
    /**
     * 顯示 Javadoc 測試
     * @param args 命令列參數
     * @return 沒有返回值
     */
    public static void main(String[] args) {
        SDisplay = "Javadoc測試";
        System.out.println(SDisplay);
    }
}

常用命令

javadoc -private -d doc -author -version JavaDocTest.java

產生 doc/ 目錄下的 HTML 文檔。一般專案僅需 javadoc YourFile.java，需客製化時參考 javadoc -help。

關鍵標籤詳解

• @author：可多個，支援 HTML 連結。
• @version：版本資訊。
• @see："text" 純文字、<a href="URL">Label</a> HTML 連結、package.class#member Label 程式元素連結。
• @param / @return：參數與返回值說明。
• {@link} 內聯範例：{@link #KEY}、{@link #getComponentAt(int)}、{@link java.util.Map Map}。

結語

善用套件管理模組化代碼，配合標準化 Javadoc 註解，能大幅減少文檔維護成本，提升團隊協作與專案長期可維護性。