2008年3月2日 星期日

L15 Interface Method需要記錄大量的資訊

Method是真正在做事情的單元,所以它使用的資訊也是最多的。Class與Package只能說是分類Method的集合標準,只會帶有它自己的規格說明與結構的關係,前者會成為標準的Documentation,後者則應該使用Class Diagram加以描繪。

在L11的Excel表格裡我們可以發現在Method的宣告就具有名稱、動作規格、傳入參數與傳回值等資訊,這些都必須一一詳加描述,才能夠讓接手的人做出符合期望的內容。其中的動作規格可以取得Activity Documentation轉到Method的Java Doc作為說明。

在方法的執行需要上,Use Case Interface Method需要Activity Diagram與Activity Interface Method List,而Activity Interface Method會在SD的階段才加以設計,但需要的內容也不外乎流程與動作的組合資訊。在Use Case Interface之外,會有開始執行該方法的時間點(Entry Point)、進入前的系統狀態(Precondition)與執行後的系統狀態(Postcondition),這些都必須在啟動系統的主流程裡加以考慮與設計。

以上所有提到的Method資訊應該全部都要說明的,但是大多數人會認為我全部都知道了為什麼要再浪費時間寫出來一遍?面對一個沒有說明的Method或許還能從少量的程式碼反推,但是面對一群沒有註解的Method時?再更慘一點,面對的是一大堆沒有分類好的Method散落在許多Class與Package時呢?其至連Class與package都沒有依據準則分類時,更是慘不忍睹。

想像一下新進人員與現在的自己對於系統認知的差距,那正是需要記錄的資訊。

沒有留言:

張貼留言