C語言初學者編程規範十條

從事C語言的教學也有不短期了，在教學中發現學生們在編程方面有一個極很差的習慣，就是隨意命名，這不只給本身往後閱讀本身程序時帶來不便，也給其餘的程序閱讀者帶來麻煩，更重要的是沒有統一的規範總顯得像是個游擊隊，沒有正規軍的感受，企業也不肯意要業餘選手，因此C語言的初學者最好一開始就培養一種良好的編程習慣，也許往後進入公司有些改動，須要適應，但基本的規範和規則是不須要改的，這樣能夠幫助你少走不少彎路，通過這些年的學習和工做，總結了一些規範的內容，爲了好記，便於傳播，特總結爲十條，建議讀者採納。

  第一：標識符的命名要清晰、明瞭，有明確含義，同時使用完整的單詞或你們基本能夠理解的縮寫，避免令人產生誤解。程序中的英文單詞通常不會太複雜，用詞應當準確。例如不要把CurrentValue寫成NowValue。

 

  第二：不容許使用漢語拼音命名，更不要使用漢語，必須使用英文來命名標識符。儘可能避免名字中出現數字編號，如Value1,Value2等，除非邏輯上的確須要編號。

 

  第三：函數名、變量名從第二個單詞起首字母大寫。如：printName(), oldName等

 

  第四：在C 程序中只使用const常量而不使用宏常量，即const常量徹底取代宏常量。常量定義以大寫字母K開頭，字母所有使用大寫，如：const int KSIZE = 100。

 

  第五：代碼縮進使用4個空格，不推薦使用TAB鍵

 

  第六：版權和版本的聲明位於文件的開頭；函數頭部應進行註釋，列出：函數的功能、輸入參數、輸出參數、返回值等。關鍵代碼註釋位於被註釋代碼上方，且用空行與其餘代碼分割開，如：

文件頭註釋：

author: SDL team

function: testing hardware drivers and IDE

date: 2009.10

copy right: Software College Of HeBei Normal University

 

 

 

函數註釋：

function:SDL initial

parameter: none

return: bool

       true:  initial SDL normally

       false:  initial SDL abnormally

 

 

 

關鍵代碼註釋：

pTemp = SDL_LoadBMP(aFileName);

 

//format BMP file

*aImg = SDL_DisplayFormat(pTemp);    

 

SDL_FreeSurface(pTemp);

 

 

 

 第七：靜態變量加前綴s_，如：static  int  s_count = 0;

 

 第八：儘可能避免應用全局變量，若是有特殊狀況必須定義的話，全局變量以小寫g_開頭，如：int  g_count = 0;

 

 第九：結構體的名字開頭字母要大寫。如：

struct Student

{

}；

 

 第十：枚舉和它的成員的定義，應該採用有意義的命名方式，避免出現歧義；枚舉變量的命名以T開頭，枚舉成員以E開頭。