Q12 努力的方向(4)──自動產生設計文件

設計文件一向都是程式設計者的最痛，除了要讓寫出的程式正常運作之外，還要把設計的理念訴諸文字。在寫完文件後倘使遇到還需要變動程式（或重構）的狀況，之前產出的文件要不是重新翻寫就是無人聞問。如果，設計文件可以跟著程式自動產生，是不是很棒的夢想？

第一份文件是Component Interface說明，每個Method的用法與說明使用都以Java Doc的方式寫成註解即可。第二份是每個方法實作的流程圖，流程寫在Flow的方法裡而動作寫在Action的方法裡，運用程式解析的工具很輕易地可以得知每個方法的流程與動作；目前至少可以抓出流程的註解與動作的Java Doc來組成步驟的順序，未來可以搭配流程圖API完成自動產生流程圖的理想。

第三份文件是每個流程與動作對於內部變數以及的Data Model、Properties與Exception使用關聯，在每個流程步驟或是動作裡，所使用到的變數、資料、參數與例外處理（不管是常數或是方法）都能夠在逐步演算程式的同時找到，只需要將各個關聯記錄下來，很容易再使用JXL產出所有的關聯追溯表。

第四份文件是每個流程與動作對於其他Package Interface Method的使用關聯，同樣可以在產生第二份文件時在每個流程步驟或是動作裡找到；只需要在處理時記錄就可以直接產出，甚至連只是單純使用或是內部有宣告變數放置都可以判別。

只要讓所有Package都具有相同的組成與意義，我相信依循這個想法所發展的設計文件產生工具並不是遙不可及的夢想；若有幸實現，這將是許多程式設計人員的幸福。