代碼規(guī)范是一個(gè)程序員最基本的要求,所以從一開始學(xué)習(xí)編程的時(shí)候就應(yīng)養(yǎng)成良好的習(xí)慣,符合代碼規(guī)范的要求。下面具體說一下C語言的代碼有哪些規(guī)范。 一、命名規(guī)范 1、匈牙利命名:基本原則:變量名=屬性+類型 +對(duì)象,每一個(gè)對(duì)象的名稱都要求有明確含義,可以取對(duì)象名字全稱或名字的一部分。命名要基于容易記憶容易理解的原則。保證名字的連貫性是非常重要的。 例子: 屬性部分: 全局變量:g_ 常量: c_ 靜態(tài)變量:s_ 類型部分: 指針 p 函數(shù) fn 無效 v 句柄 h 長整型 l 布爾 b 浮點(diǎn)型 f 雙字 dw 字符串 s 短整型 n 雙精度浮點(diǎn) d 計(jì)數(shù) c(通常用 cnt) 字符 ch(通常用 c) 整型 i(通常用 n) 字節(jié) by 字 w 實(shí)型 r 無符號(hào) u 描述部分: 最大 Max 最小 Min 初始化 Init 臨時(shí)變量 T(或 Temp) 源對(duì)象 Src 目的對(duì)象 Dest 例子: 定義一個(gè)int類型局部變量:int nResult; 定義一個(gè)int類型全局變量:int g_nResult; 定義一個(gè)指針類型數(shù)組:char* pCResult[24]; 定義一個(gè)函數(shù):fnAdd(); …… 2、駝峰式命名:第一個(gè)單詞首字母小寫,后面其他單詞首字母大寫(又稱小駝峰式)。 例子: 定義一個(gè)int類型局部變量:int myAge; 定義一個(gè)指針類型數(shù)組:char* myResult[24]; 定義一個(gè)函數(shù):myAdd(); …… 3、帕斯卡命名:每個(gè)單詞的第一個(gè)字母都大寫(又稱大駝峰式)。 例子: 定義一個(gè)int類型局部變量:int MyAge; 定義一個(gè)指針類型數(shù)組:char* MyResult[24]; 定義一個(gè)函數(shù):MyAdd(); …… 4、其他命名方式:比如下劃線命名。 例子: 定義一個(gè)int類型局部變量:int My_Age; 定義一個(gè)指針類型數(shù)組:char* My_Result[24]; 定義一個(gè)函數(shù):My_Add(); …… 以上幾種命名方式,讀者朋友只需要使用一種就可以了,筆者這里推薦第一種匈牙利命名。 二、代碼編輯排列: 1、變量的定義盡可能放在最開始處,功能相近的函數(shù)集中放在一起。 2、聲明變量時(shí)對(duì)齊變量名,并在定義時(shí)寫上注釋。 3、函數(shù)間要使用空行分開,每個(gè)函數(shù)定義時(shí)寫注釋。 4、某一段代碼寫上具體的注釋,標(biāo)注具體完成什么功能。 5、函數(shù)或過程的開始、結(jié)構(gòu)的定義及循環(huán)、判斷等語句的代碼都要采用縮進(jìn)風(fēng)格,case語句下的情況處理語句也要遵從縮進(jìn)風(fēng)格。 6、程序塊的分界符“{”與“}”應(yīng)各占一行。 7、工程項(xiàng)目中不起作用的文件、代碼、變量等應(yīng)刪除。 8、說明性文件(如頭文件.h文件、.inc文件、.def文件等)頭部應(yīng)寫上注釋。 9、程序要有作者信息、程序功能描述、版本信息、完成時(shí)間、修改日志等信息。 10、建議將常用頭文件全部放入stdafx.h中,而每個(gè)cpp開始處嵌入stdafx.h。避免不必要的錯(cuò)誤。 |
|