C++程序设计规范

下列内容主要记录注释和命名两部分

一、注释
C++语言注释有两种方式:行注释和语句块注释。
行注释用于注释一行代码,使用双斜线“//”来表示注释符,行注释右边部分作为注释部分,例如:int nData = 10; //定义一个整形变量,初始化为10
语句块注释用于将一段代码注释掉,使用“/*” 和 “*/”作为语句块注释符,“/*”和“*/”之间的部分将成为注释部分,例如:

/*                      //行注释开始
void Invoke()
{
    int s_nNum = 0;
    cout << s_nNum << endl;
    s_nNum ++;
}
*/                      //行注释结束 

在使用语句块注释时需要注意“/*” 与 “*/” 并不能按层次对应,比如下面的注释是非法的:

/*                      //外层注释 
void Invoke()
{
    /*                  //内层注释 
    int s_nNum = 0;
    cout << s_nNum << endl;
    s_nNum ++;
    */                  //内层注释 
}
*/                      //外层注释

在上面注释中,外层注释“/*”是与内层注释“*/”匹配的,而不是与外层注释“*/”匹配,因此
“}”没有被注释掉,外层注释“*/”成为了代码的一部分,不能被编译。

另外在使用注释时,应注意以下事项:
1、注释只是对代码的简要说明,并不是文档,注释过多,会让人眼花缭乱。如果代码简洁,清楚,则不需要使用注释。
2、代码与注释同时进行,甚至在写代码前先注释。
3、注释通常放在代码上方或右方。

二、命名
C++命名规则如下:
1、又英文字母、数字和下划线组成。
2、英文字母大小写要加以区别。
3、不允许使用数字开头。
4、不能用C++中的关键字。

对于变量的命名,在命名过程中应减少拼音的使用并且所使用单词的首字母最好大写,对于不经常使用的数据类型应注释,如:
bool(BOOL)用b开头bVisible
byte(BYTE)用by开头byFlag
short(int)用n开头nCount
long(LONG)用l开头lSum
char(CHAR)用c开头cCount
float(FLOAT)用f开头fSum
double(DOUBLE)用d开头dSum
unsigned int(WORD)用w开头wCount
unsigned long(DWORD)用dw开头dwCount
HANDLE(HINSTANCE)用h开头hHandle
LPCSTR(LPCTSTR)用str开头strString
用‘\0’结尾的字符串用sz开头szFileName
指针变量需在指针变量的名称前加字母p,二级指针变量加pp
全局变量应在变量名称前加g_。
静态变量应以s_开头。
成员变量应以m_开头。
枚举变量应以em_开头。
结构体变量应以S开头。
联合类型变量应以U开头。
类的命名应以C开头。
常量的命名通常都应使用大写字母。#define FILE_OPEN 10
对于const关键字标识的变量应在名称前加上c_。
函数的命名应遵循英语语法中动宾结构的命名法则并尽量表达出函数功能。
BOOL FindFile(const char * szFilePath); //查找文件
对于大结构参数应使用指针或引用进行传递,并为区分入口参数和出口参数应在入口参数前加上const关键字。
BOOL CopyString(const char * c_szSource, char * szDest); //字符串复制

猜你喜欢

转载自blog.csdn.net/qq_42107473/article/details/82559636