C:代码规范
命名规范
C:代码规范
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、程序块的分界符“{”与“}”应各占一行。
7、工程项目中不起作用的文件、代码、变量等应删除。
8、说明性文件(如头文件.h文件、.inc文件、.def文件等)头部应写上注释。
9、程序要有作者信息、程序功能描述、版本信息、完成时间、修改日志等信息。
10、建议将常用头文件全部放入stdafx.h中,而每个cpp开始处嵌入stdafx.h。避免不必要的错误。