首页 > 代码库 > c编程规范

c编程规范




1)     标识符的命名要清晰、明了,有明确含义,同时使用完整的单词或大家基本可以理解的缩写,避免使人产生误解。程序中的英文单词一般不会太复杂,用词应当准确。例如不要把CurrentValue写成NowValue。

 

2)     不允许使用汉语拼音命名,更不要使用汉语,必须使用英文来命名标识符。尽量避免名字中出现数字编号,如Value1,Value2等,除非逻辑上的确需要编号。

 

3)     函数名、变量名从第二个单词起首字母大写。如:printName(), oldName等

 

4)     在C 程序中只使用const常量而不使用宏常量,即const常量完全取代宏常量。常量定义以大写字母K开头,字母全部使用大写,如:const int KSIZE = 100。

 

5)     代码缩进使用4个空格,不推荐使用TAB键

 

6)     版权和版本的声明位于文件的开头;函数头部应进行注释,列出:函数的功能、输入参数、输出参数、返回值等。关键代码注释位于被注释代码上方,且用空行与其他代码分割开,如:

文件头注释:

 

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);

 

 

 

7)     静态变量加前缀s_,如:static int s_count = 0;

 

8)     尽量避免应用全局变量,如果有特殊情况必须定义的话,全局变量以小写g_开头,如:int g_count = 0;

 

9)     结构体的名字开头字母要大写。如:

struct Student

{

};

 

10) 枚举和它的成员的定义,应该采用有意义的命名方式,避免出现歧义;枚举变量的命名以T开头,枚举成员以E开头。