2007年9月11日 星期二

E03 實作的準則──Coding Standard

在結束設計進入實作之前,為了維持所有撰寫程式的產出有一定的風格與使用規則,這時必須有一份Coding Standard供所有程式人員作為程式實作的遵循規則。

Coding Standard的規定範圍甚廣,從命名規則、匯入宣告、註解內容、撰寫風格、甚至連括號的位置都會有所規範,其用意就在於專案裡任何一個人都能夠立即看懂其他人所寫出來的程式。我們可以想像命名方式不同時另一個人還得多花時間去明白一些很基本的東西,這都會是無形的資源浪費,同步好基本想法後,專案成員就可以投注更多心力在於系統的功能開發。

接著應該會有通用API文件,瞭解並熟悉這些通用API的使用可以快速地組成需要的小功能;在不清楚有哪些通用API的情形下,會時常發現到處都會散落著有同樣功能的小方法,如此一來呼叫的使用關係無法收斂,也降低了程式碼的共用性。

再上一層要有通用元件的使用文件,讓開發人員依照設計的要求傳入正確的物件及變數,並作正確的判斷。API層級的所有文件,都是要讓所有人知道如何使用基本的功能與元件來達成設計的內容。

經由規範與準則,我們可以同步專案中所有人員的基本想法與產出水準。

沒有留言:

張貼留言