G19 驗收的文件(7)──ＡＰＩ參考文件

在OOAD開發流程下，在每個Class、每個方法與每個屬性被設計出來的時候，應該都已經有它應該存在的原因與其對應要去處理的動作。在Java的開發環境裡，幾乎只要使用Java Doc把所有程式碼的註解跑過一遍就可以擁有完整的API文件了。

在Component的情形下，除了基本的註解顯示的內容，應再附上Properties使用的名稱與其影響的功能，以及在各種不同的例外狀況下傳回Exception裡的所有傳回狀況代號；如果有使用到任何外部檔案的時候，也要包含檔案格式的說明。當然這些在元件設計的時候都應該同時有追溯表才是。

在把方法視為函數呼叫的類別裡，最重要的是詳細說明每一個方法的呼叫方法與作用，最好是能附上幾個使用範例。這些內容的寫法可以參考JDK的API文件寫法。

對開發與維護的人員來說，API參考文件就有如系統的開發API字典一樣，要包含系統層次裡所有可能會使用到的Class、方法與屬性說明。