關於」代碼既文檔「的新思考

關於」代碼既文檔「的新思考

• 博客分類：
• 思想

軟件測試編程

我原來也很贊成」代碼既文檔「的想法，認為有很大的可行性，只是沒有發展出相應的流程和工具機制，才沒有成功。

最近的一些思索讓我發現這方面還沒有那麼簡單，主要是在抽象級別方面。代碼描述的是系統的內部實現構造，而文檔描述的是系統的外在表現。

即使是加在代碼上的結構化的注釋，主要表達的也是系統是如何實現的，它可以說明一段代碼，一個方法，一個類，甚至一個組件是做什麼的，但這些依然不是系統最終用戶所能直接理解和受益的資料。

對於軟件工程來說，文檔的作用是告訴不了解實現技術的人（如最終用戶），系統是做什麼的；或者告訴了解實現技術，但沒有時間和必要性去深入細節的人（如實施人員），系統的實現思路。

系統的內在機制和外在表現之間需要知識介質聯系起來，目前這種知識就體現在軟件文檔中。