2009年5月8日 星期五

V07 自動補齊註解(2)──Method的傳入參數與傳回值

版權宣告與Class註解僅是靜態的說明,解析的重點還是在於Method。Java Doc的最基本是說明Method的功能,使用param記錄傳入參數名稱與類型、return記錄傳回類型、throws記錄拋出的例外類型,都與Method的宣告行有關。

設計者在改變方法宣告的同時,不一定會去更正Java Doc的內容,因此仍然需要加上自動補齊的功能令它們同步。註解需要的內容都可以從Method宣告行拿到,列出的資訊與Java Doc轉成的Data Model比較後,刪除多出的屬性、自動補上缺少的欄位並調整順序以符合Method的宣告。自動產生的部分應加上標示(例如[AUTO])以方便事後搜尋出來作人工的調整。

開發團隊都會定義自己所用的Naming Rules,在處理Class與Method的同時也可以依照規則檢查各個屬性的名稱;同時也可以檢查屬性名稱後是否有加上說明。以上應有而未有的註解可以在應加上的地方註明[TODO]表示少了些東西,以便快速定位後補加上去。

到現在為止處理的是Class與Method宣告的部分,在詳細描述的區塊務必在先用第一句簡短地描述其功用,後面再跟著註記詳細的說明;這是因為未來需要Class與Method的註解時會取得第一個句子作為使用內容(避免內容過多)。

註:如果Method是實作Interface或是覆寫父類別的Method,就不要在這層產生宣告註解而應該產生指向宣告的註解內容。

沒有留言:

張貼留言