采用 Javadoc 形式的集成文檔有利有弊(轉(zhuǎn))

Java 語言按照 Javadoc 注釋約定采用了一種集成的方法來進(jìn)行 API 文檔編制。Javadoc 工具可以幫助生成好的 API 文檔，然而大多數(shù) Java API 文檔卻很糟糕。因為它是源代碼的一部分，所以 API 的文檔編制職責(zé)最終還是落到了工程師身上。在本文中，Brian 對 Java 文檔編制實踐的當(dāng)前狀態(tài)進(jìn)行了嚴(yán)厲的批評，同時提供了一些關(guān)于如何編寫更有用的 Javadoc 的準(zhǔn)則。
對于大多數(shù) Java 類庫來說，Javadoc 是唯一的文檔。而且，除了商業(yè)軟件組件之外，許多 Java 類不會用到 Javadoc。雖然 Javadoc 作為 API 參考工具很出色，但對于了解類庫是如何組織的和應(yīng)該如何使用它來說，它卻是一種十分差勁的方法。并且即便用了 Javadoc，它通常只包含有關(guān)方法完成了什么的最基本信息，而忽略了諸如錯誤處理、參數(shù)及返回值的作用域和范圍、線程安全、鎖定行為、前置條件、后置條件、不變條件或副作用之類的重要特性。

向 Javadoc 學(xué)習(xí)
對于包括大多數(shù)開放源碼包和大多數(shù)內(nèi)部開發(fā)的組件在內(nèi)的許多 Java 工具而言，實際情況是：包括 Javadoc 在內(nèi)，幾乎所有類庫或組件都不具有有效的文檔。這就意味著開發(fā)人員要從 Javadoc 學(xué)習(xí)使用工具，而且我們應(yīng)該考慮根據(jù)這一現(xiàn)實組織我們的 Javadoc。我經(jīng)常開玩笑說：現(xiàn)在，Java 程序員需要具備的最重要的技能之一是熟練地使用 Google 和 Javadoc 來對那些文檔編制得十分糟糕的 API 進(jìn)行“逆向工程”。這可能是真的，但卻并不十分好笑。

大多數(shù) Java 包都有某種“根”對象，它是在得到該工具內(nèi)的任何其它對象之前，必須創(chuàng)建的第一個對象。在 JNDI 中，該根對象是 Context，而在 JMS 和 JDBC 中，它是 Connection。如果有人告訴您 JDBC 中的基礎(chǔ)對象是 Connection，以及如何獲得這一對象，那么接著您很可能會從 Javadoc 中通過仔細(xì)察看 Javadoc 中可用的方法列表找到如何創(chuàng)建并執(zhí)行 Statement，以及如何迭代生成的 ResultSet。但您如何知道獲得 Connection 是您的第一步呢？Javadoc 在包內(nèi)按照字母順序組織類，在類中按照字母順序組織方法。遺憾的是，Javadoc 中沒有神奇的“從這里開始（Start Here）”記號把讀者帶到瀏覽 API 的邏輯開始位置。

包描述
最接近“從這里開始”記號的是包描述，但它卻很少得到有效的使用。如果將文件 package.html 與源代碼一起放在一個包中，那么標(biāo)準(zhǔn)的 doclet 會將已生成的 package-summary.html 文件中的內(nèi)容連同類列表一起放在該包內(nèi)。遺憾的是，生成我們都很熟悉的 HTML 文檔的標(biāo)準(zhǔn) doclet 卻無法使包描述易于找到。如果您單擊左上窗格中的某個包，那么這會在左下窗格中產(chǎn)生方法列表，但并不會在主窗格中產(chǎn)生包的摘要 ? 必須單擊左下窗格中的包名稱來查看摘要。但不要緊，畢竟大多數(shù)包并沒有包描述。

包文檔是一個放置“從這里開始”文檔的極好的地方，這一文檔用來概述包做什么、主要摘要是什么以及從何處開始瀏覽包的 Javadoc。

類文檔
除包文檔之外，特定于類的文檔對于幫助用戶徹底了解新工具也能起到重要的作用。類文檔當(dāng)然應(yīng)該包括此特定類做什么的描述，但還應(yīng)該描述該類與包中的其它類如何關(guān)聯(lián)，特別是要標(biāo)識任何與該類相關(guān)的工廠類。例如，JDBC 中的 Statement 類文檔應(yīng)該說明：Statement 是通過 Connection 類的 createStatement() 方法獲得的。這樣，如果一個新用戶偶然進(jìn)入 Statement 頁面，那么他會發(fā)現(xiàn)首先他需要獲得 Connection。對每個類都應(yīng)用這一約定的包會迅速為用戶指出根對象，用戶因而能夠得心應(yīng)手。

因為 Javadoc 是圍繞對特定類進(jìn)行文檔編制而設(shè)計的，因此在 Javadoc 中通常沒有明顯的位置來放置演示幾個相關(guān)類一起使用的示例代碼。但由于一味地側(cè)重于特定類或方法的文檔編制，我們失去了討論如何組合包中內(nèi)容的機(jī)會。如果對于根對象，在包文檔或類文檔中有一個演示一些基本用法的簡單代碼示例，則對于許多用戶來說，將是非常有用的。例如，Connection 類文檔可以有一個簡單示例，該示例獲取連接、創(chuàng)建預(yù)編譯語句、執(zhí)行該語句并迭代結(jié)果集。從技術(shù)上說，這可能不屬于 Connection 頁面，因為它還描述了包中的其它類。然而，尤其是當(dāng)結(jié)合了上面那種引用當(dāng)前類所依賴的類的技術(shù)時，用戶才能非常迅速地找到獲取簡單的實用示例的途徑，不管類的組織方式如何。

糟糕的文檔 == 糟糕的代碼
對于大多數(shù) Java 類庫來說，除了那些作為打包組件出售的商業(yè)產(chǎn)品之外，要么沒有 Javadoc，要么非常糟糕。由于存在的事實是對于大多數(shù)包來說，Javadoc 是我們擁有的唯一文檔，這基本上意味著使我們自己陷入了這樣的困境：除了作者之外，其他人沒法使用我們的大部分代碼 ? 如果不付出重大的“考古”一樣的努力，至少會這樣。

由于文檔現(xiàn)在是代碼的一部分，因此我認(rèn)為是軟件工程社區(qū)形成一個共識的時候了，這就是，即使代碼很出色，如果文檔很糟糕，也應(yīng)該被認(rèn)為是差勁的代碼，因為不能有效地重用。單元測試不久前還聲譽(yù)不佳，只是到了最近它才受到了許多工程師的青睞，就和它一樣，為了改善我們生產(chǎn)的軟件的可靠性和可重用性，API 文檔也必須成為開發(fā)過程的一個集成部分。

編寫 Javadoc 就是某種形式的代碼檢查
編寫合理的 Javadoc 也會產(chǎn)生副作用，它迫使我們進(jìn)行某種形式的代碼檢查，來研究類的體系結(jié)構(gòu)和它們之間的關(guān)系。如果單個包、類或方法很難編制文檔，那么或許可以嘗試同時對多個包、類或方法進(jìn)行文檔編制，這應(yīng)該是個提示，即可能它需要重新設(shè)計。

文檔的自我檢查方面使得某些方面更加重要，即在開發(fā)過程中盡早編寫 Javadoc，然后隨著代碼的不斷開發(fā)，定期對其進(jìn)行檢查，而不是僅僅等待代碼完成再編寫文檔（如果有剩余時間的話）。后一種策略十分常見，它將編寫文檔拖到項目最后，而那時時間安排十分緊張，開發(fā)人員的壓力也很大。結(jié)果再常見不過了，就是圖 1 所示的那種一文不值的文檔，它只提供了“文檔假象”。用戶真正需要的是了解該類的工作原理，而該文檔卻沒有提供任何這樣的信息。

清單 1. 典型的一文不值的 Javadoc
/**
* Represents a command history
*/
public class CommandHistory {

/**
* Get the command history for a given user
*/
public static CommandHistory getCommandHistory(String user) {
. . .
}
}



那么好的文檔包括哪些內(nèi)容呢？
上面描述的組織技術(shù)（在類描述中引用相關(guān)類或工廠類，也包括了包概述和代碼樣本）是形成優(yōu)秀文檔的好開端。它有助于新用戶使用 Javadoc 了解新工具。

但體系結(jié)構(gòu)的概述只完成了任務(wù)的一半。另一半則是詳細(xì)地解釋方法做什么和不做什么、在什么條件下運(yùn)行以及它們?nèi)绾翁幚礤e誤條件。大多數(shù) Javadoc 都沒有完全提供所需的信息，即便是那些充分描述了方法在期望情況下的行為的 Javadoc 也是如此，這些缺少的信息包括：

方法如何處理錯誤條件或不合要求的輸入
如何將錯誤條件傳回給調(diào)用者
可能會拋出哪個特定異常的子類
哪些值對于輸入是有效的
類不變條件、方法前置條件或方法后置條件
副作用
在方法之間是否有重要聯(lián)接
類如何處理多個線程同時訪問一個實例的情況。
Javadoc 約定提供了 @param 標(biāo)記，它讓我們除了能夠?qū)?shù)的名稱和類型編制文檔之外，還可以對其意義編制文檔。然而，并不是所有的方法都能很好地接受參數(shù)的任何值。例如，雖然可以合法地向任何獲取對象參數(shù)的方法傳遞空值（null）而不違反類型檢查規(guī)則，但并不是所有的方法都能在傳入空值時正常工作。Javadoc 應(yīng)該顯式地描述有效的參數(shù)范圍，如果它希望某個參數(shù)非 null，那么它應(yīng)該這樣描述，而如果它期望參數(shù)值在某個范圍內(nèi)，例如某種長度的字符串或大于 0 的整數(shù)，那么它也應(yīng)該那樣描述。并非所有方法都仔細(xì)檢查其參數(shù)的有效性；不進(jìn)行有效性檢查也沒有編制關(guān)于可接受的輸入范圍的文檔，這二者的結(jié)合為災(zāi)難埋下了隱患。

返回代碼
Javadoc 使得描述返回值的意義變得很容易，但正如方法參數(shù)一樣，@return 標(biāo)記應(yīng)該包括對可能返回的值范圍的詳細(xì)描述。對于對象取值的返回類型而言，它會返回空值嗎？對于整數(shù)取值的返回類型而言，結(jié)果會限制在一個已知值或非負(fù)值的集合上嗎？任何返回代碼都有特殊意義嗎，例如從 java.io.InputStream.read() 返回 -1 表示文件結(jié)束符？返回代碼會被用來表示例如如果無法找到表項則返回空值那樣的錯誤條件嗎？

異常
標(biāo)準(zhǔn) doclet 復(fù)制方法的 throws 子句，但 Javadoc @throws 標(biāo)記應(yīng)該更為具體。例如，NoSuchFileException 是 IOException 的子類，但 java.io 中的大多數(shù)方法卻只被聲明為拋出 IOException。然而，方法可能獨(dú)立于其它 IOException 而拋出 NoSuchFileException，這是調(diào)用者要了解的很有用的事實 ? 它應(yīng)該被包括在 Javadoc 中。還應(yīng)該指出拋出各種異常類的實際錯誤條件，以便調(diào)用者知道在給定異常被拋出時該采取什么糾正措施。應(yīng)該用 @throws 標(biāo)記對方法可能拋出的每個經(jīng)檢查的或未經(jīng)檢查的異常編制文檔，并對引發(fā)拋出異常的條件編制文檔。

前置條件、后置條件和不變條件
當(dāng)然，您應(yīng)該對方法對對象狀態(tài)的影響編制文檔。但您可能需要編制得更詳細(xì)一些，描述方法的前置條件、后置條件和類不變條件。前置條件是在調(diào)用方法前對對象狀態(tài)的約束；例如，調(diào)用 Iterator.next() 的前置條件是 hasMore() 為真。后置條件是方法調(diào)用完成后對對象狀態(tài)的約束，例如在調(diào)用 add() 之后 List 不能為空。不變條件是對對象狀態(tài)的一種約束，它保證該狀態(tài)始終為真，例如 Collection.size() == Collection.toArray().length()。

諸如 jContract 之類的按契約設(shè)計（Design-by-contract）工具允許您使用特殊注釋指定前置條件、后置條件和類不變條件，這類工具然后生成額外代碼來強(qiáng)制這些約束。無論您是否使用工具來強(qiáng)制這些期望條件，對這些約束編制文檔可以讓用戶知道要安全地使用類，他們可以做些什么。

副作用
有時候，方法除了改變對象狀態(tài)之外還會有其它副作用，例如改變相關(guān)對象、JVM 或底層計算平臺的狀態(tài)。例如，所有執(zhí)行 I/O 的方法都有副作用。有些副作用是無害的，例如保留類處理的請求的記數(shù)。另外一些副作用則會對程序性能和正確性產(chǎn)生重大影響，例如修改傳遞給方法的對象的狀態(tài)，或存儲對該對象的引用的副本。諸如修改相關(guān)對象的狀態(tài)或存儲對作為方法參數(shù)傳遞的對象的引用之類的副作用應(yīng)該編制文檔。

方法聯(lián)接
方法聯(lián)接意味著類中的兩個方法相互依賴，并且都對對方的行為做了假定。發(fā)生方法聯(lián)接的一種常見情形是：方法在內(nèi)部使用同一個類的 toString 方法，并假定 toString 將以特別的方法格式化對象狀態(tài)。如果該類已經(jīng)子類化并且 toString 方法被重寫了，那么這種情形可能引起問題；另一個方法會突然不能正常工作，除非它也被重寫。如果您的方法依賴于其它方法的實現(xiàn)行為，那么需要對那些依賴性編制文檔。而且，如果類已子類化，那么可以以一致的方式重寫兩種方法以便使子類仍能正常工作。

線程安全
應(yīng)該編制文檔的最重要的行為之一是線程安全，而對它幾乎從未編制文檔。這個類是線程安全的嗎？如果不是，那么是否可以通過用同步封裝調(diào)用來使其線程安全嗎？這些同步必須同特定管程相關(guān)聯(lián)，還是任何一直使用的管程都可以使用呢？方法獲得了對于類外部是可見的對象的鎖嗎？

線程安全實際上不是二進(jìn)制屬性；線程安全有幾種可標(biāo)識的等級。對線程安全編制文檔，或者甚至確定線程安全的等級并非總是很容易。但未能進(jìn)行這一工作將導(dǎo)致嚴(yán)重的問題；在并發(fā)應(yīng)用程序中使用非線程安全類可能引起零星的故障，這些故障常常直到部署時才出現(xiàn)（那時暴露應(yīng)用程序以便裝入）。而且將額外鎖定封裝在已經(jīng)是線程安全的類周圍會影響性能，甚至引起死鎖。

Josh Bloch 在他的 Effective Java Programming Language Guide（參閱參考資料）一書中對類的線程安全等級編制文檔提供了有用的分類法。可以按照線程安全遞減順序?qū)㈩悮w到下列某一組：不可變、線程安全、有條件的線程安全、線程兼容和線程對立。

這種分類是一個極佳的框架，用于在并發(fā)訪問情況下傳遞關(guān)于類行為的重要信息。不管您是否使用這一分類法都沒關(guān)系，但您應(yīng)該標(biāo)識您的類意圖顯示的線程安全等級。我還建議：如果方法獲得對一個對象的鎖定，而該對象對于類自身的代碼外部是可見的，那么您也應(yīng)該就此編制文檔，即使這只是一個“實現(xiàn)細(xì)節(jié)”，以便協(xié)助做出全局鎖定順序（global-lock-order）決策并防止死鎖。

結(jié)束語
對類的行為編制文檔遠(yuǎn)遠(yuǎn)不只是對每個方法做什么給出一行描述。有效的 Javadoc 應(yīng)該包括對下列內(nèi)容的描述：

類如何相互關(guān)聯(lián)
方法如何影響對象的狀態(tài)
方法如何將出錯條件通知它們的調(diào)用者以及它們可能通知什么錯誤
類如何處理多線程應(yīng)用程序中的使用
方法的參數(shù)作用域及其返回值的范圍
另外，糟糕的文檔（或甚至更糟糕，沒有文檔）會導(dǎo)致優(yōu)秀的代碼不可用或不可重用。通過在文檔上花一些額外時間，您將為您的用戶（可能是您自己）避免無數(shù)的挫折。

參考資料

單擊文章頂部或底部的討論來參加關(guān)于本文的論壇。


Sun 教程“How to Write Doc Comments for the Javadoc Tool”描述了 Javadoc 的規(guī)則和基本原理。


Josh Bloch 的 Effective Java Programming Language Guide 包含了有關(guān)編寫更好代碼的大量有用提示和指導(dǎo)原則。


Peter Haggar 的文章“Acquire multiple locks in a fixed, global order to prevent deadlock”（developerWorks，2000 年 9 月）描述了一種降低死鎖風(fēng)險的技術(shù)，但這種技術(shù)依賴于對鎖定行為的有效的文檔。


JContract 是一種強(qiáng)制類契約和類約束的商業(yè)工具。


文章“Exceptional Practices”（JavaWorld，2001 年 8 月）提供了編寫 throws 子句的指導(dǎo)原則。


Jeremy Roschelle 的文章“Doclet your servlet”（JavaWorld，2001 年 3 月）描述了可以怎樣使用定制 doclet 來為 servlet 更為詳細(xì)的文檔。


John Farrell 在“Make bad code good”（JavaWorld，2001 年 3 月）中談到了 Javadoc 在重構(gòu) Java 類方面的重要性。


Scott Ambler 為編制方法文檔提供了便捷的檢查表（developerWorks，2001 年 8 月）。


Javadoc doclet API 讓您編寫定制 Javadoc 插件來生成不同形式的文檔，或甚至從 Javadoc 注釋自動生成代碼或模式。[@more@]