自己總結的C 編碼規範

2021-12-29 21:03:47 字數 1128 閱讀 1814

格式

乙個檔案最好不要超過500行(除ide自動生成的類)。

乙個檔案必須只有乙個命名空間,嚴禁將多個命名空間放在乙個檔案裡。

乙個檔案最好只有乙個類。

如果超過500行,考慮拆分類或者使用partial 類將類按照功能拆分。

乙個方法的**最好不要超過50行,如果超過考慮將裡面的邏輯封裝成函式。

空格、空行

空行的使用以使**清晰為為基本原則。空行影響程式的執行,但可以使**看起來清晰,增加可讀性,因此可以適當的使用。

方法與方法之間有兩個空行

函式內部變數宣告與函式內部邏輯之間有乙個空行。

函式內部乙個邏輯完成後要有乙個空行,然後再寫下乙個邏輯

換行換行掌握的原則是不要使一行**特別長,以方便讀者快速閱讀。

請團隊所有成員開啟visual studio自動換行功能。

tools->options->text editor->c#->check the word wrap checkbox  

在不產生嚴重歧義或增加閱讀難度的情況下,盡量控制在80列以內,不能超過120列,以方便閱讀和**的列印。

另外換行的原則是,在逗號後,操作符前換行,換行與首行要保持乙個單位的縮排。

""必須單獨在一行上,且上下對齊。

if,while,do,try-catch-finaly 等語句後必須有{},即使裡面只有一條語句或語句為空,且遵循""必須單獨在一行上上的規定。  

region的使用

region的使用可以明確**塊的範圍並提供相應注釋,因此提倡大家盡量使用。

同時region也可以用來組織**結構,我們使用以下region約定來使組織類:

乙個類應該用region劃分出fields、properties、constructor、private methods和 protected & public methods 五個區域。並按照上述順序從上到下排列。

其中fields、properties、constructor、private methods必須放在region。而protected & public methods 必須放在外面。protected & public methods 是**閱讀者查詢最頻繁的內容,這樣做可以方便**閱讀者使用ctrl+m, o時能夠最快速度定位到自己想要查詢的內容。 

總結的編碼規範

1 巨集定義格式 每個單詞用下劃線隔開。示例 define yyy 20 define yyy 20 各用兩個 tab隔開 2 一律不得出現常量,對於出現的常量 指數字和字串 用意義明顯的巨集定義 或列舉變數 代替。3 每個函式體不能過長,原則上不超過 200行 4 每個檔案不能過長,原則上不超過 ...

C 編碼規範

c 編碼規範 規範的制定原則 1 參照微軟在vs.net中,c 既有的規範來制定 2 方便 的交流和維護。3 不影響編碼的效率,不與大眾習慣衝突。4 使 更美觀 閱讀更方便。5 使 的邏輯更清晰 更易於理解。規範的遵守原則 1 如果是軟體外包專案,並且對方制定了 的編寫規範,則首先要遵守對方的編碼規...

C 編碼規範

c 編碼規範 1.目的 為了保證企業編寫出的程式都符合相同的規範,保證一致性 統一性而建立的程式編碼規範。2.範圍 適用於企業所有基於.平台的軟體開發工作。3.規範內容 3.1.格式 u 所有的縮排為4個空格,使用vs.的預設設定。u 在 中垂直對齊左括號和右括號。if x 0 不允許以下情況 if...