《开发管理之代码编码规范》由会员分享，可在线阅读，更多相关《开发管理之代码编码规范（17页珍藏版）》请在金锄头文库上搜索。
1、-1. 程序版式1.1. 对齐1.1.1. 程序块要采用缩进风格编写，缩进的空格数为4个。使用VC提供的Tab键对齐。1.1.2. ”和”应独占一行并且位于同一列，同时引用他们的语句对齐1.1.3. 之的代码块在”右边数格外左对齐例：正确错误void Function(int *) / program codevoid Function(int *) / program codeif (condition) / program codeelse / program codeif (condition) / program codeelse / program codefor (initiali
2、zation; condition; update) / program codefor (initialization; condition; update) / program codeWhile (condition) / program codewhile (condition) / program code如果出现嵌套的，则使用缩进对齐，如：1.2. 空行1.2.1. 每个声明之后，每个函数定义之后要加空行1.2.2. 在一个函数体，逻辑上密切相关的语句之间不加空行，其它地方应加空行分隔1.2.3. 变量声明和代码之间加空行1.2.4. 函数返回语句用空行例：void Functio
3、n1()/ 空行void Function2()void Function1() / 空行void Function2() / 空行while (condition)statement1;/ 空行if (condition) statement2;elsestatement3;/ 空行Return statement4 1.3. 代码行1.3.1. 一行代码只做一件事情，如只定义一个变量，或只写一条语句。1.3.2. if、for、do、while、case、switch、default等语句自占一行，且if、for、do、while等语句的执行语句部分无论多少都要加括号例：示例：风格良好的代
4、码行示例：风格不良的代码行int width;/ 宽度int height;/ 高度int depth;/ 深度int width, height, depth;/ 宽度高度深度*=a + b;y = c + d;z = e + f;* a + b; y = c + d; z = e + f;if (width height) dosomething();if (width = 2000) / 良好的风格if(year=2000) / 不良的风格if (a=b) & (c=b&c=d) / 不良的风格for (i=0; i10; i+) / 良好的风格for(i=0;i10;i+) / 不良的
5、风格for (i = 0; I 10; i +) / 过多的空格* = a b a : b; / 良好的风格*=aFunction();/ 不要写成 b - Function();1.5. 长行拆分1.5.1. 代码行最长度宜控制在70到80个字符以，代码行不宜过长1.5.2. 长表达式拆分，应将操作符放在新行之首，拆分出新行要适当缩进，使排版整齐例：if (very_longer_variable1 = very_longer_variable12)& (very_longer_variable3 = very_longer_variable14)& (very_longer_variabl
6、e5 = very_longer_variable16) dosomething();virtual CMatri* CMultiplyMatri* (CMatri* leftMatri*, CMatri* rightMatri*);for (very_longer_initialization; very_longer_condition; very_longer_update)dosomething();1.6. 修饰的位置1.6.1. 修饰符*和&应靠近变量名：char *name; int *, y1.7. 类的版式1.7.1. 将public写前面，protect在其后，privat
7、e写后面，以行为中心1.7.2. 变量在函数声明之后1.7.3. 逻辑相关的函数排列在一起例：class A public:void Func1(void);void Func2(void);/空行int i, j; protect:void Func3(void);void Func4(void);float *, y; private:void Func5(void);void Func6(void);/空行string a, b; 2. 代码注释规则（例文件）2.1. 每个文件头2.1.1. 阐述该文件包含的容2.1.2. 对include的文件要注释2.2. 每个函数的头部2.2.1.
8、 注明函数名称、函数说明、输入参数和返回值2.3. 每个类（即头文件）2.3.1. 注明类的用途2.4. 函数当中需要注释不易明折的地方2.4.1. 算法2.4.2. 设计思想2.4.3. 独到的用处2.5. 原则2.5.1. 注释和代码一样要及时更新2.5.2. 注释不是代码的重复2.5.3. 全部使用/”方式注释2.5.4. 注释尽量不要单独占一行2.5.5. 注释要简洁、明了2.5.6. 边写代码边写注释，MFC自带的代码注释不用修改2.5.7. 对于所有有物理含义的变量、常量，如果其命名不是充分自注释的，在声明时都必须加以注释，说明其物理含义。变量、常量、宏的注释应放在其上方相邻位置或
9、右方。2.5.8. 将注释与其上面的代码用空行隔开/* 函数名称：* 函数说明：* 输入参数：* 返 回 值：*/void Function(float *, float y, float z) if () while () / end of while / end of if3. 命名规3.1. 共性规则3.1.1. 不可用汉语拼音，用英文、用词应准确3.1.2. 应用大小写混排方式，如：AddChild 3.1.3. 程序中不要出现仅靠大小写区分的相似的标识符3.1.4. 程序中不要出现标识符完全相同的简单变量和全局变量3.1.5. 变量名应当使用名词”或形容词+名词”，如：float f
10、Value;float fOldVlaue;float fNewValue;3.1.6. 函数名应使用动词或动词+名词，如：void GetValue();3.1.7. 用正确的反义词组命名具有互斥定义的变量或相反动作的函数，如： int nMinValue;int nMa*Value;int nSetValue;int nGetValue;3.1.8. 对于借来的代码，不改变其命名3.2. 命名规则3.2.1. 类名和函数名用大写字母开头的单词组合而成，如：class Node;class LeafNode;void SetValue();3.2.2. 变量和参数用小写字母开头的单词组合而成，如：BOOF bflag,;int nDrawMode;float fHeight;string strTitle;char cSource;3.2.3. 常量全用大写字母，用下划线分割单词 DDD_SAF3.2.4. 静态变量前加前缀s_，如：Static int s_initValue;3.2.5. 如果不得已需要全局变量，全局变量前加前缀g_，如：int g_howManyPeople3.2.6. 类的数据成员加前缀m_，如：void objet:Set Value(int width, int height)m_width=width;m_heig
