Javadoc利弊分析

2019-11-18 11:17:02

字體：大中小

供稿：網(wǎng)友

　　我必須對(duì)那些內(nèi)容進(jìn)行文檔編制嗎？
　　采用 javadoc 形式的集成文檔有利有弊
　　
　　級(jí)別：中級(jí)
　　
　　Brian Goetz（brian@quiotix.com）
　　
　　首席顧問，Quiotix Corp
　　
　　2002 年 10 月
　　
　　Java 語(yǔ)言按照 Javadoc 注釋約定采用了一種集成的方法來進(jìn)行 API 文檔編制。Javadoc 工具可以幫助生成好的 API 文檔，然而大多數(shù) Java API 文檔卻很糟糕。因?yàn)樗窃创a的一部分，所以 API 的文檔編制職責(zé)最終還是落到了工程師身上。在本文中，Brian 對(duì) Java 文檔編制實(shí)踐的當(dāng)前狀態(tài)進(jìn)行了嚴(yán)厲的批評(píng)，同時(shí)提供了一些關(guān)于如何編寫更有用的 Javadoc 的準(zhǔn)則。
　　
　　對(duì)于大多數(shù) Java 類庫(kù)來說，Javadoc 是唯一的文檔。而且，除了商業(yè)軟件組件之外，許多 Java 類不會(huì)用到 Javadoc。雖然 Javadoc 作為 API 參考工具很出色，但對(duì)于了解類庫(kù)是如何組織的和應(yīng)該如何使用它來說，它卻是一種十分差勁的方法。并且即便用了 Javadoc，它通常只包含有關(guān)方法完成了什么的最基本信息，而忽略了諸如錯(cuò)誤處理、參數(shù)及返回值的作用域和范圍、線程安全、鎖定行為、前置條件、后置條件、不變條件或副作用之類的重要特性。
　　
　　向 Javadoc 學(xué)習(xí)
　　對(duì)于包括大多數(shù)開放源碼包和大多數(shù)內(nèi)部開發(fā)的組件在內(nèi)的許多 Java 工具而言，實(shí)際情況是：包括 Javadoc 在內(nèi)，幾乎所有類庫(kù)或組件都不具有有效的文檔。這就意味著開發(fā)人員要從 Javadoc 學(xué)習(xí)使用工具，而且我們應(yīng)該考慮根據(jù)這一現(xiàn)實(shí)組織我們的 Javadoc。我經(jīng)常開玩笑說：現(xiàn)在，Java 程序員需要具備的最重要的技能之一是熟練地使用 Google 和 Javadoc 來對(duì)那些文檔編制得十分糟糕的 API 進(jìn)行“逆向工程”。這可能是真的，但卻并不十分好笑。
　　
　　大多數(shù) Java 包都有某種“根”對(duì)象，它是在得到該工具內(nèi)的任何其它對(duì)象之前，必須創(chuàng)建的第一個(gè)對(duì)象。在 JNDI 中，該根對(duì)象是 Context，而在 JMS 和 JDBC 中，它是 Connection。假如有人告訴您 JDBC 中的基礎(chǔ)對(duì)象是 Connection，以及如何獲得這一對(duì)象，那么接著您很可能會(huì)從 Javadoc 中通過仔細(xì)察看 Javadoc 中可用的方法列表找到如何創(chuàng)建并執(zhí)行 Statement，以及如何迭代生成的 ResultSet。但您如何知道獲得 Connection 是您的第一步呢？Javadoc 在包內(nèi)按照字母順序組織類，在類中按照字母順序組織方法。遺憾的是，Javadoc 中沒有神奇的“從這里開始（Start Here）”記號(hào)把讀者帶到瀏覽 API 的邏輯開始位置。
　　
　　包描述
　　最接近“從這里開始”記號(hào)的是包描述，但它卻很少得到有效的使用。假如將文件 package.Html 與源代碼一起放在一個(gè)包中，那么標(biāo)準(zhǔn)的 doclet 會(huì)將已生成的 package-summary.html 文件中的內(nèi)容連同類列表一起放在該包內(nèi)。遺憾的是，生成我們都很熟悉的 HTML 文檔的標(biāo)準(zhǔn) doclet 卻無(wú)法使包描述易于找到。假如您單擊左上窗格中的某個(gè)包，那么這會(huì)在左下窗格中產(chǎn)生方法列表，但并不會(huì)在主窗格中產(chǎn)生包的摘要 ― 必須單擊左下窗格中的包名稱來查看摘要。但不要緊，究竟大多數(shù)包并沒有包描述。
　　
　　包文檔是一個(gè)放置“從這里開始”文檔的極好的地方，這一文檔用來概述包做什么、主要摘要是什么以及從何處開始瀏覽包的 Javadoc。
　　
　　類文檔
　　除包文檔之外，特定于類的文檔對(duì)于幫助用戶徹底了解新工具也能起到重要的作用。類文檔當(dāng)然應(yīng)該包括此特定類做什么的描述，但還應(yīng)該描述該類與包中的其它類如何關(guān)聯(lián)，非凡是要標(biāo)識(shí)任何與該類相關(guān)的工廠類。例如，JDBC 中的 Statement 類文檔應(yīng)該說明：Statement 是通過 Connection 類的 createStatement() 方法獲得的。這樣，假如一個(gè)新用戶偶然進(jìn)入 Statement 頁(yè)面，那么他會(huì)發(fā)現(xiàn)首先他需要獲得 Connection。對(duì)每個(gè)類都應(yīng)用這一約定的包會(huì)迅速為用戶指出根對(duì)象，用戶因而能夠得心應(yīng)手。
　　
　　因?yàn)?Javadoc 是圍繞對(duì)特定類進(jìn)行文檔編制而設(shè)計(jì)的，因此在 Javadoc 中通常沒有明顯的位置來放置演示幾個(gè)相關(guān)類一起使用的示例代碼。但由于一味地側(cè)重于特定類或方法的文檔編制，我們失去了討論如何組合包中內(nèi)容的機(jī)會(huì)。假如對(duì)于根對(duì)象，在包文檔或類文檔中有一個(gè)演示一些基本用法的簡(jiǎn)單代碼示例，則對(duì)于許多用戶來說，將是非常有用的。例如，Connection 類文檔可以有一個(gè)簡(jiǎn)單示例，該示例獲取連接、創(chuàng)建預(yù)編譯語(yǔ)句、執(zhí)行該語(yǔ)句并迭代結(jié)果集。從技術(shù)上說，這可能不屬于 Connection 頁(yè)面，因?yàn)樗€描述了包中的其它類。然而，尤其是當(dāng)結(jié)合了上面那種引用當(dāng)前類所依靠的類的技術(shù)時(shí)，用戶才能非常迅速地找到獲取簡(jiǎn)單的實(shí)用示例的途徑，不管類的組織方式如何。
　　
　　糟糕的文檔 == 糟糕的代碼
　　對(duì)于大多數(shù) Java 類庫(kù)來說，除了那些作為打包組件出售的商業(yè)產(chǎn)品之外，要么沒有 Javadoc，要么非常糟糕。由于存在的事實(shí)是對(duì)于大多數(shù)包來說，Javadoc 是我們擁有的唯一文檔，這基本上意味著使我們自己陷入了這樣的困境：除了作者之外，其他人沒法使用我們的大部分代碼 ― 假如不付出重大的“考古”一樣的努力，至少會(huì)這樣。
　　
　　由于文檔現(xiàn)在是代碼的一部分，因此我認(rèn)為是軟件工程社區(qū)形成一個(gè)共識(shí)的時(shí)候了，這就是，即使代碼很出色，假如文檔很糟糕，也應(yīng)該被認(rèn)為是差勁的代碼，因?yàn)椴荒苡行У刂赜谩卧獪y(cè)試不久前還聲譽(yù)不佳，只是到了最近它才受到了許多工程師的青睞，就和它一樣，為了改善我們生產(chǎn)的軟件的可靠性和可重用性，API 文檔也必須成為開發(fā)過程的一個(gè)集成部分。
　　
　　編寫 Javadoc 就是某種形式的代碼檢查
　　編寫合理的 Javadoc 也會(huì)產(chǎn)生副作用，它迫使我們進(jìn)行某種形式的代碼檢查，來研究類的體系結(jié)構(gòu)和它們之間的關(guān)系。假如單個(gè)包、類或方法很難編制文檔，那么或許可以嘗試同時(shí)對(duì)多個(gè)包、類或方法進(jìn)行文檔編制，這應(yīng)該是個(gè)提示，即可能它需要重新設(shè)計(jì)。
　　
　　文檔的自我檢查方面使得某些方面更加重要，即在開發(fā)過程中盡早編寫 Javadoc，然后隨著代碼的不斷開發(fā)，定期對(duì)其進(jìn)行檢查，而不是僅僅等待代碼完成再編寫文檔（假如有剩余時(shí)間的話）。后一種策略十分常見，它將編寫文檔拖到項(xiàng)目最后，而那時(shí)時(shí)間安排十分緊張，開發(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ù)的一半。另一半則是具體地解釋方法做什么和不做什么、在什么條件下運(yùn)行以及它們?nèi)绾翁幚礤e(cuò)誤條件。大多數(shù) Javadoc 都沒有完全提供所需的信息，即便是那些充分描述了方法在期望情況下的行為的 Javadoc 也是如此，這些缺少的信息包括：
　　
　　方法如何處理錯(cuò)誤條件或不合要求的輸入
　　如何將錯(cuò)誤條件傳回給調(diào)用者
　　可能會(huì)拋出哪個(gè)特定異常的子類
　　哪些值對(duì)于輸入是有效的
　　類不變條件、方法前置條件或方法后置條件
　　
　　副作用
　　在方法之間是否有重要聯(lián)接
　　
　　類如何處理多個(gè)線程同時(shí)訪問一個(gè)實(shí)例的情況。
　　
　　Javadoc 約定提供了 @param 標(biāo)記，它讓我們除了能夠?qū)?shù)的名稱和類型編制文檔之外，還可以對(duì)其意義編制文檔。然而，并不是所有的方法都能很好地接受參數(shù)的任何值。例如，雖然可以合法地向任何獲取對(duì)象參數(shù)的方法傳遞空值（null）而不違反類型檢查規(guī)則，但并不是所有的方法都能在傳入空值時(shí)正常工作。Javadoc 應(yīng)該顯式地描述有效的參數(shù)范圍，假如它希望某個(gè)參數(shù)非 null，那么它應(yīng)該這樣描述，而假如它期望參數(shù)值在某個(gè)范圍內(nèi)，例如某種長(zhǎng)度的字符串或大于 0 的整數(shù)，那么它也應(yīng)該那樣描述。并非所有方法都仔細(xì)檢查其參數(shù)的有效性；不進(jìn)行有效性檢查也沒有編制關(guān)于可接受的輸入范圍的文檔，這二者的結(jié)合為災(zāi)難埋下了隱患。
　　
　　返回代碼
　　Javadoc 使得描述返回值的意義變得很輕易，但正如方法參數(shù)一樣，@return 標(biāo)記應(yīng)該包括對(duì)可能返回的值范圍的具體描述。對(duì)于對(duì)象取值的返回類型而言，它會(huì)返回空值嗎？對(duì)于整數(shù)取值的返回類型而言，結(jié)果會(huì)限制在一個(gè)已知值或非負(fù)值的集合上嗎？任何返回代碼都有非凡意義嗎，例如從 java.io.InputStream.read() 返回 -1 表示文件結(jié)束符？返回代碼會(huì)被用來表示例如假如無(wú)法找到表項(xiàng)則返回空值那樣的錯(cuò)誤條件嗎？
　　
　　異常
　　標(biāo)準(zhǔn) doclet 復(fù)制方法的 throws 子句，但 Javadoc @throws 標(biāo)記應(yīng)該更為具體。例如，NoSUChFileException 是 IOException 的子類，但 java.io 中的大多數(shù)方法卻只被聲明為拋出 IOException。然而，方法可能獨(dú)立于其它 IOException 而拋出 NoSuchFileException，這是調(diào)用者要了解的很有用的事實(shí) ― 它應(yīng)該被包括在 Javadoc 中。還應(yīng)該指出拋出各種異常類的實(shí)際錯(cuò)誤條件，以便調(diào)用者知道在給定異常被拋出時(shí)該采取什么糾正措施。應(yīng)該用 @throws 標(biāo)記對(duì)方法可能拋出的每個(gè)經(jīng)檢查的或未經(jīng)檢查的異常編制文檔，并對(duì)引發(fā)拋出異常的條件編制文檔。
　　
　　前置條件、后置條件和不變條件

上一篇：JBuilder使用中的常見問題歸納整理

下一篇：使用布局管理器呈現(xiàn)生動(dòng)的JAVA程序界面