某知名软件公司内部c开发标准.docVIP

PAGE 上海SMISOL C\C++代码编写规范 Version 1.1 2001年4月16日 C\C++代码编写规范 Ver1.1 PAGE １９ 目的 使用统一编码编写规范的主要原因，是使应用程序的结构和编码风格标准化，使其他成员共享劳动成果。 本规范 注重于程序的物理结构和外观，而不是程序的逻辑结构。它们使其他人的编码更加容易阅读、容易理解而且容易维护。 命名规则 总则：命名要用英语，单词简单，明了，意义明确。每个单词的第一个字母应该大写，单词与单词之间直接连接，用大写字母加以区别，定语应该放在被修饰语的前面.不能放在被修饰语的后面.。函数名称和工程名称杜绝直接使用A,B,C,1,2,3,汉语拼音或人名等难以理解的单词，对于变量名称也要避免 如此命名。命名书写的基本原则是匈牙利命名法.复杂变量 (复杂变量变量指,类和结构的实例)应该有统一的缩写原则和常用变量的缩写列表. 命名的长度应当符合“min-length max-information”原则。一般来说，长名字能更好地表达含义。单字符的名字也是有用的，常见的如i,j,k,m,n,x,y,z等，它们通常可用作函数内的局部变量 工程命名 工程项目的意义名称根据项目组讨论决定.并在此工程意义名称的前面添加大写的“SS”(ShangHai Smisol )作为此工程项目的工程命名。 如：工程项目的意义名称为Model，工程名称为SSModel 对应的Visual C++的工程文件名为SSModel.dsp 类(CLASS)的命名 所有的类（ＣＬＡＳＳ）的名字必须以“CSS“开头．“CSS “后第一个字母应该大写．Ｅｘａｍｐｌｅ：　CSSImage．所以对于类（ＣＬＡＳＳ）的头文件和原文件，遵循ＶＣ的命名规则．去掉字母Ｃ即可.Example :　SSImage.h，SSImage.cpp 函数的命名 全局函数 全局函数的命名必须符合 ：限定名词 + 动词 [+名词] 的原则。如：long RmodelGetCenter(double x, double y) 的Rmodel为限定名词Get为动词Center为名词。限定名词根据工程名称统一规定。 类成员函数 类成员函数的命名必须符合：动词[+名词]的原则。如：在CRImage class 中void GetWidth(double *Width) 名词Get为动词Width为名词。类的成员函数只使用“动词”，被省略掉的名词就是对象本身。例如： RmodelDrawImage(); // 全局函数 Image-Draw(); // 类的成员函数 宏 全部要用大写字母。并用下划线分割单词。如：#define MAX_IMAGE_LENGTH 1024 文件的命名 头文件(H)，代码文件(CPP) 对于类（CLASS）的头文件和代码文件的命名遵循ＶＣ的命名规则.去掉字母Ｃ即可。Example ：对于CSSImage class头文件和代码文件分别为SSImage.h,SSImage.cpp. 对于全局函数的头文件和代码文件的命名，应该遵循: SS+ 限定名词+[其他] + cpp/H。如SSRmodelCreate.h和SSRmodelCreate.cpp.其中SS 为文件名前缀，Rmodel为限定词，Create表明此代码文件是产生关于Rmodel的文件。 资源文件 资源文件与工程文件同名，仅仅后缀不同而已。如：对于SSModel.dsp而言，资源文件名称为SSModel.rc. def文件 def文件因该与工程文件同名，仅仅后缀不同而已。如：对于SSModel.dsp而言，def文件名称为SSModel.def. 变量的命名 变量的命名应该遵循匈牙利命名法。即：[限定词 + ‘_’ + ] 类型缩写+意义名词。 全局变量的命名 全局变量的限定词为字母”g”。所以全局变量必须以小写字母”g_”开始。如int g_nImageNumber ：“g“表示全局变量“n“表示此变量为int 型 , “ImageNumber“表示此变量的意义。 局部变量的命名 局部变量不必要加限定词。即：类型缩写+意义名词。如int nImageNumber ： “n“表示此变量为int 型 , “ImageNumber“表示此变量的意义。 类中的成员变量的命名 类中的成员变量命名的限定词为字母”m”。所以类中的成员变量命名必须以小写字母” m_”开始。如int m_nImageNumber ：“m“表示类中变量 “n“表示此变量为int 型 , “ImageNumber“表示此变量的意义。 静态变量 静态变量加限定词为”s”，所以对于类中的成员静态变量命名必须以小写字母” ms_”开始。如int ms_n