前言:
通過建立代碼編寫規範,形成BCB開發小組編碼約定,提高程式的可靠性、可讀性、可修改性、可維護性、一致性,保證程式碼的品質,繼承軟體開發成果,充分利用資源。提高程式的可繼承性,使開發人員之間的工作成果可以共用。
軟體編碼要遵循以下原則:
1.遵循開發流程,在設計的指導下進行代碼編寫。
2.代碼的編寫以實現設計的功能和效能為目標,要求正確完成設計要求的功能,達到設計的效能。
3.程式具有良好的程式結構,提高程式的封裝性好,減低程式的耦合程度。
4.程式可讀性強,易於理解;方便調試和測試,可測試性好。
5.便於使用和維護;良好的修改性、擴充性;可重用性強/移植性好。
6.佔用資源少,以低代價完成任務。
7.在不降低程式的可讀性的情況下,盡量提高代碼的執行效率。
本規範的描述主要以 Borland C++ Builder 語言為例
一、規範:以下對本規範作詳細說明。
1:來源程式的檔案管理:
a)組織:每個程式檔案單元通常都應由 .cpp、.dfm和 .h 等檔案組成,並將單元的公用聲明部分放在 .h 檔案中。劃分單元主要是以類為依據,原則上每個較大的類都應為一個單獨的單元,但在類較小且多個小類別關係密切等情況下也可幾個類共一個單元(建議僅對已經詳細測試的較為通用的類採用)。
b)命名:原程式檔案命名採用有意義的格式。例如:對登陸程式來說三個檔案的命名應該是這樣,.cpp的是 Login.cpp .dfm的是Login.dfm .h的是Login.h
c)檔案結構:每個程式檔案由標題、內容和附加說明三部分組成。
(A)標題:檔案最前面的注釋說明,其內容主要包括:程式名,作者,版本資訊,簡要說明等,必要時應有更詳盡的說明(將以此部分以空行隔開單獨注釋)。
(B)內容:為檔案原始碼部分基本上按預先處理語句、類型定義、變數定義、函數原型、函數實現(僅對 .cpp 檔案)的順序。 main 、 winmain ,控制項註冊等函數應放在內容部分的最後,類的定義按 private 、 protected 、 pubilic 、 __pubished 的順序,並盡量保持每一部分只有一個,各部分中按資料、函數、屬性、事件的順序。