N14 設計的製程(9)──Component的說明文件

對要使用的人來說，只需要說明詳盡的Component Interface註解就足以知道它是否適用；真正要使用時需要的是Component Interface Method的Java Doc加上簡單的使用範例。所以讓使用者明白Component的功能與用法是撰寫文件的方向。

功能與用途寫在Class的註解，常數與用法則寫在public Data與Method前，所有說明都用Java Doc的寫法以便產生給使用者觀看的文件。除了單一Component的內容之外，還要準備所有Component的分類清單，讓使用者快速依功能需要找出所有可以被應用的Component再從中挑選最適合的。

給維護人員看的是設計的想法，依之前提到的原則與順序，提供描繪Class與Interface的Package Diagram，同時在裡面標示所有Data Model、Action、Properties、Exception等靜態的方法，再以實作Component Interface Method的Controller說明來串連，就可以快速明白所有的方法合作的概念。

Component文件主要在於使用上的描述，讓使用者只要看文件就會運用的話，可以省掉教學的時間。由於理論上Component會在許多系統內使用，通常在初期時就會經過需求確認與較多測試，維護方面的要求相對的就會比較低一些。