1 文件註釋

1.1 基本格式

/** * @author 李國生 * @version 1.0 */

1.2 如何生成對應的文件註釋

javadoc -d 生成到目標資料夾名 -xx -yy 註釋所在Java檔案

-xx
-yy 文件使用了哪些標籤

例如：javadoc -d d:\\ -author -version Comment02.java

1.3 常用標籤

@author 作者標識 包、 類、介面
@deprecated 標識當前API已經過期，僅為了保證相容性依然存在，以此告之開發者不應再用這個API 包、類、介面、值域、建構函式、 方法
{@docRoot} 指明當前文件根目錄的路徑
@exception 標誌一個類丟擲的異常 建構函式、 方法
{@inheritDoc} 從直接父類繼承的註釋
{@link} 連結到某個特定的成員對應的文件中 包、類、介面、值域、建構函式、 方法
{@linkplain} 插入一個到另一個主題的連結，但是該連結顯示純文字字型 包、類、介面、值域、建構函式、 方法
@param 方法的入參名及描述資訊，如入參有特別要求，可在此註釋 建構函式、方法
@return 對函式返回值的註釋 方法
@see 引用,檢視相關內容，如類、方法、變數等 包、類、介面、值域、建構函式、 方法
@serial 說明一個序列化屬性
@serialData 說明通過writeObject( ) 和 writeExternal( )方法寫的資料
@serialField 說明一個ObjectStreamField元件 @
@since 描述文字,API在什麼程式的什麼版本後開發支援 包、類、介面、值域、建構函式、 方法
@throws 建構函式或方法所會丟擲的異常 建構函式、 方法
{@value} 顯示常量的值，該常量必須是static屬性 靜態值域
@version 版本號 包、 類、介面

2 相對路徑

相對路徑：從當前目錄開始定位，形成的一個路徑
絕對路徑：從根目錄開始定位，形成的一個路徑

如：

D:
--abc資料夾
--test100資料夾
--test200資料夾
---abc2目錄
--test100資料夾
--test200資料夾
--hello.txt

當前目錄：D:/abc/test100
需求1.從abc/test100訪問abc2/test200/hello.txt目錄
相對路徑：..\..\abc2\tet200\hello.txt
絕對路徑：D:\abc2\test200\hello.txt