威賽兒商務通系統開發員手冊蘇康勝(cancan28@163.net) 一、前言為了保證商務通系統項目開發成本優化并且有利于將來的擴展及重用,項目成員必須嚴格遵守以下開發手冊。力求達成一種默認的開發規范。 二、設計約定l 系統將采用RDS技術訪問遠程組件,必須記住RDS不支持對象的屬性的這一限制。 l 系統必須提供統一靈活的錯誤處理機制,統一管理組件的返回信息。 l 系統組件盡量遵守松耦合的原則,使組件在能重用的基礎之上還能適應今后更多方面的變更。 l 為了使系統具有很強的移植性,設計要排除對使用存儲過程實現的依賴等。 l 組件的設計應該避免產生過多的創建數據庫連接請求。 l 詳細設計必須詳細到每個組件及方法和接口。 l 采用Rational Rose做為系統分析設計的輔助工具。 l 設計必須配合項目管理,輔助需求管理人員提供需求基線依據。 l 必須及時獲取程序員反饋信息,修補設計時的漏洞。 l 其他補充可以找蘇康勝商量。 三、程序規范a)VB的編程規范在軟件開發過程中,編程的工作量是相當大的,同一項目參與編程的人可能有各自編程的經驗和習慣,不同風格的程序代碼帶來了維護工作量的增加,因此為了提高代碼的可讀性、系統的穩定性及維護和升級的成本,程序的代碼必須嚴格遵循統一的編程規范。 總則: 應有良好的、盡可能一致的編程風格 編碼應該是嚴謹的、可讀性強、目標明確及直觀的。 注釋: 無論是用戶端表示層程序還是組件程序,注釋必不可少。要求能占程序總量的20%,另外注釋必須在程序改變時實時更新。 每個構件的頂部應該有注釋 包括:模塊名稱 功能描述 設計 作者 構件內的每個過程或方法應該有注釋 包括:功能描述 參數說明 返回值說明 作者 更新 創建日期 最后更新日期 每個模塊級變量必須給出注釋 重要的變量應該給出注釋 描述變量的用途 變量、常量、對象的命名規約 命名必須使用大小寫結合(VB編輯器會自動轉換以減少程序出錯的機率) 變量命名采用[范圍前綴][數組前綴][類型前綴]+[自定義命名] 控件命名采用[控件前綴]+[自定義命名] 變量范圍做前綴
|
溫馨提示:喜歡本站的話,請收藏一下本站!