2009年5月11日 星期一

V08 自動補齊註解(3)──補齊Method內的程式碼註解

元件六個部分裡Properties、Model與Exception的程式碼是簡單到不需要用註解說明的,自動補齊程式碼註解的對象是Implementation、Flow與Action。依照我的設計準則,每一層被上一層呼叫到的入口Method都應該只用程式流程的敍述來呼叫實際動作的方法。

流程相關的方法有以下五種,標示種類為流程者表示內部應只放流程敍述與動作方法呼叫。
●Implementation Method(入口方法)
 beforeInvoke()與afterInvoke()內放的是流程,細部的動作只能是Flow Method或是其它的Component Interface。
●Flow Method且被Implementation Method直接呼叫(被入口方法呼叫的流程方法)
●Flow Method但只被Flow Method呼叫(內部流程方法)
 以上兩種都屬於流程,細部動作只能是Flow Method、Action Method或是其它的Component Interface。
●Action Method且被Flow Method直接呼叫(被流程方法呼叫的動作方法)
 這屬於實作流程,細部動作只能是Action Method或是其它的Component Interface。
●Action Method但只被Action Method呼叫(內部動作方法)
 這屬於實作流程,細部動作只能是Action Method或是其它的Component Interface。不過到這層應該大多都是呼叫很底層的API,產生的流程內容已經不易讀懂。

除了最後一種Method之外,其他種類的Method只能放置流程控制的指令。為這幾種指令定義好註解的範本,再從實際執行的方法註解裡取得第一行的功能簡述嵌入到註解範本裡,產成註解結果後放置到程式碼前即可。依序執行每個Class的每個Method裡的每行程式,就可以用同樣的方法產生全部的程式碼註解,並可以隨時依真實的註解同步最新的內容。

沒有留言:

張貼留言