回覆列表
-
1 # 愛達人程式設計達人
-
2 # C語言基礎
3.3 程式設計規範
3.3.1 命名規範
3.3.1.1駝峰命令法
大駝峰:DisplayInfo();
小駝峰:displayInfo();
3.3.1.2匈牙利命名法
m_lpszStr
3.3.1.3帕斯卡(Pascal)命名法
大駝峰:DisplayInfo();
3.3.2 程式碼規範
3.3.2.1程式塊要採用縮排風格編寫
3.3.2.2 較長的語句(>80)要分成多行書寫
3.3.2.3 函式引數較長,適當的劃分
3.3.2.4 一行只寫一條語句。
3.3.3 註釋規範
3.3.3.1 說明性註釋
(.h檔案)
3.3.3.2 原始檔註釋
3.3.3.3 函式註釋
3.3.3.4 註釋量
一般情況下,源程式有效註釋量必須在20%以上。
程式碼規範是一個程式設計師最基本的要求,所以從一開始學習程式設計的時候就應養成良好的習慣,符合程式碼規範的要求。下面具體說一下C語言的程式碼有哪些規範。
一、命名規範
1、匈牙利命名:基本原則:變數名=屬性+型別 +物件,每一個物件的名稱都要求有明確含義,可以取物件名字全稱或名字的一部分。命名要基於容易記憶容易理解的原則。保證名字的連貫性是非常重要的。
例子:
屬性部分:
全域性變數:g_
常量: c_
靜態變數:s_
型別部分:
指標 p
函式 fn
無效 v
控制代碼 h
長整型 l
布林 b
浮點型 f
雙字 dw
字串 s
短整型 n
雙精度浮點 d
計數 c(通常用 cnt)
字元 ch(通常用 c)
整型 i(通常用 n)
位元組 by
字 w
實型 r
無符號 u
描述部分:
最大 Max
最小 Min
初始化 Init
臨時變數 T(或 Temp)
源物件 Src
目的物件 Dest
例子:
定義一個int型別區域性變數:int nResult;
定義一個int型別全域性變數:int g_nResult;
定義一個指標型別陣列:char* pCResult[24];
定義一個函式:fnAdd();
……
2、駝峰式命名:第一個單詞首字母小寫,後面其他單詞首字母大寫(又稱小駝峰式)。
例子:
定義一個int型別區域性變數:int myAge;
定義一個指標型別陣列:char* myResult[24];
定義一個函式:myAdd();
……
3、帕斯卡命名:每個單詞的第一個字母都大寫(又稱大駝峰式)。
例子:
定義一個int型別區域性變數:int MyAge;
定義一個指標型別陣列:char* MyResult[24];
定義一個函式:MyAdd();
……
4、其他命名方式:比如下劃線命名。
例子:
定義一個int型別區域性變數:int My_Age;
定義一個指標型別陣列:char* My_Result[24];
定義一個函式:My_Add();
……
以上幾種命名方式,讀者朋友只需要使用一種就可以了,筆者這裡推薦第一種匈牙利命名。
二、程式碼編輯排列:
1、變數的定義儘可能放在最開始處,功能相近的函式集中放在一起。
2、宣告變數時對齊變數名,並在定義時寫上註釋。
3、函式間要使用空行分開,每個函式定義時寫註釋。
4、某一段程式碼寫上具體的註釋,標註具體完成什麼功能。
5、函式或過程的開始、結構的定義及迴圈、判斷等語句的程式碼都要採用縮排風格,case語句下的情況處理語句也要遵從縮排風格。
6、程式塊的分界符“{”與“}”應各佔一行。
8、說明性檔案(如標頭檔案.h檔案、.inc檔案、.def檔案等)頭部應寫上註釋。
9、程式要有作者資訊、程式功能描述、版本資訊、完成時間、修改日誌等資訊。
10、建議將常用標頭檔案全部放入stdafx.h中,而每個cpp開始處嵌入stdafx.h。避免不必要的錯誤。