當前位置:學者齋 >

計算機 >C語言 >

C語言基礎之編碼規範

C語言基礎之編碼規範

學習程式設計編碼一定要規範,下面小編整理了C語言基礎編碼規範知識,希望對大家有幫助!

C語言基礎之編碼規範

  1. 基本要求

1.1 程式結構清析,簡單易懂,單個函式的程式行數不得超過100行。

1.2 打算幹什麼,要簡單,直接了當,程式碼精簡,避免垃圾程式。

1.3 儘量使用標準庫函式和公共函式。

1.4 不要隨意定義全域性變數,儘量使用區域性變數。

1.5 使用括號以避免二義性。

  2.可讀性要求

2.1 可讀性第一,效率第二。

2.2 保持註釋與程式碼完全一致。

2.3 每個源程式檔案,都有檔案頭說明,說明規格見規範。

2.4 每個函式,都有函式頭說明,說明規格見規範。

2.5 主要變數(結構、聯合、類或物件)定義或引用時,註釋能反映其含義。

2.7 常量定義(DEFINE)有相應說明。

2.8 處理過程的每個階段都有相關注釋說明。

2.9 在典型演算法前都有註釋。

2.10 利用縮排來顯示程式的邏輯結構,縮排量一致並以Tab鍵為單位,定義Tab為 6個位元組。

2.11 迴圈、分支層次不要超過五層。

2.12 註釋可以與語句在同一行,也可以在上行。

2.13 空行和空白字元也是一種特殊註釋。

2.14 一目瞭然的'語句不加註釋。

2.15 註釋的作用範圍可以為:定義、引用、條件分支以及一段程式碼。

2.16 註釋行數(不包括程式頭和函式頭說明部份)應占總行數的 1/5 到 1/3 。

 3. 結構化要求

3.1 禁止出現兩條等價的支路。

3.2 禁止GOTO語句。

3.3 用 IF 語句來強調只執行兩組語句中的一組。禁止 ELSE GOTO 和 ELSE RETURN。

3.4 用 CASE 實現多路分支。

3.5 避免從迴圈引出多個出口。

3.6 函式只有一個出口。

3.7 不使用條件賦值語句。

3.8 避免不必要的分支。

3.9 不要輕易用條件分支去替換邏輯表示式。

 4. 正確性與容錯性要求

4.1 程式首先是正確,其次是優美

4.2 無法證明你的程式沒有錯誤,因此在編寫完一段程式後,應先回頭檢查。

4.3 改一個錯誤時可能產生新的錯誤,因此在修改前首先考慮對其它程式的影響。

4.4 所有變數在呼叫前必須被初始化。

4.5 對所有的使用者輸入,必須進行合法性檢查。

4.6 不要比較浮點數的相等,

如: 10.0 * 0.1 == 1.0 , 不可靠

4.7 程式與環境或狀態發生關係時,必須主動去處理髮生的意外事件,如檔案能否

邏輯鎖定、印表機是否聯機等。

4.8 單元測試也是程式設計的一部份,提交聯調測試的程式必須通過單元測試。

5. 可重用性要求

5.1 重複使用的完成相對獨立功能的演算法或程式碼應抽象為公共控制元件或類。

5.2 公共控制元件或類應考慮OO思想,減少外界聯絡,考慮獨立性或封裝性。

5.3 公共控制元件或類應建立使用模板。

標籤: 編碼 規範 語言
  • 文章版權屬於文章作者所有,轉載請註明 https://xuezhezhai.com/zh-tw/jsj/cyuyan/eolq69.html