底层软件设计规范
第1章文件结构
每个C程序通常分为两个文件。一个文件用于保存程序的声明，称为头文件。另一个文件用于保存程序的实现，称为定义文件。
C程序的头文件以“.h”为后缀，C程序的定义文件以“.c”为后缀。 1.1版权和版本的声明
版权和版本的声明位于头文件和定义文件的开头，主要内容有： （1）版权信息。
（2）文件名称，标识符，摘要。
（3）当前版本号，作者/修改者，完成日期。 （4）版本历史信息。
/* * Copyright (c) 2010,成都中天鼎盛科技有限公司 * All rights reserved. * *文件名称：filename.h *文件标识：见配置管理计划书 *摘要：简要描述本文件的内容
1 / 20
*
*当前版本：1.1
*作者：输入作者（或修改者）名字 *完成日期：2010年2月8日 *
*取代版本：1.0
*原作者：输入原作者（或修改者）名字 *完成日期：2010年2月9日*/ 1.2头文件的结构
头文件由三部分内容组成：
（1）头文件开头处的版权和版本声明。 （2）预处理块。
（3）函数和类结构声明等。
【规则1-2-1】为了防止头文件被重复引用，应当用ifndef/define/endif结构产生预处理块。 【规则1-2-2】用#include 【规则1-2-3】用#include“filename.h”格式来引用非标准库的头文件（编译器将从用户的工作目录开始搜索）。 2 / 20 【建议1-2-1】头文件中只存放“声明”而不存放“定义”。建议将成员函数的定义与声明分开，不论该函数体有多么小。 【建议1-2-2】不提倡使用全局变量，尽量不要在头文件中出现象externintvalue这类声明。//版权和版本声明见示例1-1，此处省略。 #ifndef GRAPHICS_H //防止graphics.h被重复引用 #define GRAPHICS_H #include #include “myheader.h”//引用非标准库的头文件 ⋯ void Function1(⋯); //全局函数声明 ⋯ class Box//类结构声明{⋯}; #endif 1.3定义文件的结构 定义文件有三部分内容： （1）定义文件开头处的版权和版本声明。 （2）对一些头文件的引用。 3 / 20 （3）程序的实现体（包括数据和代码）。 //版权和版本声明 #include “graphics.h” //引用头文件 ⋯ //全局函数的实现体 void Function1(⋯) { ⋯ }//类成员函数的实现体 void Box::Draw(⋯) { ⋯ } 第2章程序的版式 2.1空行 空行起着分隔程序段落的作用。空行得体（不过多也不过少）将使程序的布局更加清晰。 空行不会浪费内存，虽然打印含有空行的程序是会多消耗一些纸张，但是值得。所以不要舍不得 4 / 20 用空行。 【规则2-1-1】在每个类声明之后、每个函数定义结束之后都要加空行。 【规则2-1-2】在一个函数体内，逻揖上密切相关的语句之间不加空行，其它地方应加空行分隔。 1、函数之间的空行 //空行 void Function1(⋯) { ⋯ } //空行 void Function2(⋯) { ⋯ } //空行 void Function3(⋯) { 5 / 20 ⋯ } //空行 2、函数内部的空行 while (condition) { statement1; //空行 if (condition) { statement2; } else { statement3; } //空行 6 / 20 statement4; } 2.2代码行 【规则2-2-1】一行代码只做一件事情，如只定义一个变量，或只写一条语句。这样的代码容易阅读，并且方便于写注释。 【规则2-2-2】if、for、while、do等语句自占一行，执行语句不得紧跟其后。不论执行语句有多少都要加{}。这样可以防止书写失误。 【建议2-2-1】尽可能在定义变量的同时初始化该变量（就近原则）如果变量的引用处和其定义处相隔比较远，变量的初始化很容易被忘记。如果引用了未被初始化的变量，可能会导致程序错误。本建议可以减少隐患。例如 int width = 10;//定义并初绐化 widthint height = 10; //定义并初绐化height int depth = 10;//定义并初绐化depth： 2.3代码行内的空格 【规则2-3-1】关键字之后要留空格。象const、virtual、inline、case等关键字之后至少要留一个空格，否则无法辨析关键字。象if、for、while等关键字之后应留一个空格再跟左括号‘（’，以突出关键字。 【规则2-3-2】函数名之后不要留空格，紧跟左括号‘（’，以与关键字区别。 【规则2-3-3】‘（’向后紧跟，‘）’、‘，’、‘;’向前紧跟，紧跟处不留空格。 7 / 20 【规则2-3-4】‘，’之后要留空格，如Function(x, y, z)。如果‘;’不是一行的结束符号，其后要留空格，如for (initialization; condition; update)。【规则2-3-5】赋值操作符、比较操作符、算术操作符、逻辑操作符、位域操作符，如“=”、“+=”“>=”、“<=”、“+”、“*”、“%”、“&&”、“||”、“<<”,“^”等二元操作符的前后应当加空格。 【规则2-3-6】一元操作符如“!”、“~”、“++”、“--”、“&”（地址运算符）等前后不加空格。 【规则2-3-7】象“［］”、“.”、“->”这类操作符前后不加空格。 【建议2-3-1】对于表达式比较长的for语句和if语句，为了紧凑起见可以适当地去掉一些空格，如for (i=0; i<10; i++)和if ((a<=b) && (c<=d)) void Func1(int x, int y, int z);//良好的风格 void Func1 (int x,int y,int z);//不良的风格 if (year >= 2000)//良好的风格 if(year>=2000)//不良的风格 if ((a>=b) && (c<=d))//良好的风格 if(a>=b&&c<=d)//不良的风格 for (i=0; i<10; i++)//良好的风格 for(i=0;i<10;i++)//不良的风格 for (i = 0; I < 10; i ++)//过多的空格 x = a < b ? a : b;//良好的风格 8 / 20 x=a 【规则2-4-1】程序的分界符‘{’和‘}’应独占一行并且位于同一列，同时与引用它们的语句左对齐。 【规则2-4-2】{ }之内的代码块在‘{’右边数格处左对齐。 2.5长行拆分 【规则2-5-1】代码行最大长度宜控制在70至80个字符以内。代码行不要过长，否则眼睛看不过来，也不便于打印。 【规则2-5-2】长表达式要在低优先级操作符处拆分成新行，操作符放在新行之首（以便突出操作符）。拆分出的新行要进行适当的缩进，使排版整齐，语句可读。 2.6修饰符的位置 修饰符*和＆应该靠近数据类型还是该靠近变量名，是个有争议的活题。 若将修饰符*靠近数据类型，例如：int*x;从语义上讲此写法比较直观，即x是int类型的指针。 上述写法的弊端是容易引起误解，例如：int*x, y;此处y容易被误解为指针变量。虽然将x和y分 9 / 20 行定义可以避免误解，但并不是人人都愿意这样做。 【规则2-6-1】应当将修饰符*和＆紧靠变量名 2.7注释 C语言的注释符为“/*„*/”。行注释一般采用“//„”。注释通常用于：（1）版本、版权声明； （2）函数接口说明； （3）重要的代码行或段落提示。 虽然注释有助于理解代码，但注意不可过多地使用注释。参见示例2-6。 【规则2-7-1】注释是对代码的“提示”，而不是文档。程序中的注释不可喧宾夺主，注释太多了会让人眼花缭乱。注释的花样要少。 【规则2-7-2】如果代码本来就是清楚的，则不必加注释。否则多此一举，令人厌烦。 例如i++;// i加1，多余的注释 【规则2-7-3】边写代码边注释，修改代码同时修改相应的注释，以保证注释与代码的一致性。不再有用的注释要删除。 【规则2-7-4】注释应当准确、易懂，防止注释有二义性。错误的注释不但无益反而有害。 【规则2-7-5】尽量避免在注释中使用缩写，特别是不常用缩写。 【规则2-7-6】注释的位置应与被描述的代码相邻，可以放在代码的上方或右方，不可放在下方。 【规则2-7-8】当代码比较长，特别是有多重嵌套时，应当在一些段落的结束处加注释，便于阅读。 10 / 20 2.8类的版式 类可以将数据和函数封装在一起，其中函数表示了类的行为（或称服务）。类提供关键字public、protected和private，分别用于声明哪些数据和函数是公有的、受保护的或者是私有的。这样可以达到信息隐藏的目的，即让类仅仅公开必须要让外界知道的内容，而隐藏其它一切内容。我们不可以滥用类的封装功能，不要把它当成火锅，什么东西都往里扔。 类的版式主要有两种方式： （1）将private类型的数据写在前面，而将public类型的函数写在后面，如示例8-3（a）。 采用这种版式的程序员主张类的设计“以数据为中心”，重点关注类的内部结构。 （2）将public类型的函数写在前面，而将private类型的数据写在后面，如示例8.3（b）采用这种版式的程序员主张类的设计“以行为为中心”，重点关注的是类应该提供什么样的接口（或服务）。 我建议读者采用“以行为为中心”的书写方式，即首先考虑类应该提供什么样的函数。 这是很多人的经验——“这样做不仅让自己在设计类时思路清晰，而且方便别人阅读。 因为用户最关心的是接口，谁愿意先看到一堆私有数据成员！ 第3章命名规则 3.1共性规则本节论述的共性规则是被大多数程序员采纳的，我们应当在遵循这些共性规则的前提下，再扩充特定的规则。 【规则3-1-1】标识符应当直观且可以拼读，可望文知意。 标识符最好采用英文单词或其组合，便于记忆和阅读。切忌使用汉语拼音来命名。程序中的英文单词一般不会太复杂，用词应当准确。例如不要把CurrentValue写成NowValue。 11 / 20 【规则3-1-2】标识符的长度应当符合“min-length && max-information”原则。一般来说，长名字能更好地表达含义，所以函数名、变量名、类名长达十几个字符不足为怪。 那么名字是否越长约好？不见得!例如变量名maxval就比maxValueUntilOverflow好用。 单字符的名字也是有用的，常见的如i,j,k,m,n,x,y,z等，它们通常可用作函数内的局部变量。【规则3-1-3】命名规则尽量与所采用的操作系统或开发工具的风格保持一致。采用Windows应用程序的标识符通常采用“大小写”混排的方式，如AddChild。 【规则3-1-4】程序中不要出现仅靠大小写区分的相似的标识符。例如：intx,X;//变量x与X容易混淆 void foo(int x); //函数foo与FOO容易混淆void FOO(float x); 【规则3-1-5】程序中不要出现标识符完全相同的局部变量和全局变量，尽管两者的作用域不同而不会发生语法错误，但会使人误解。 【规则3-1-6】变量的名字应当使用“名词”或者“形容词＋名词”。例如：floatvalue; floatoldValue; floatnewValue; 【规则3-1-7】全局函数的名字应当使用“动词”或者“动词＋名词”（动宾词组）。类的成员函数应当只使用“动词”，被省略掉的名词就是对象本身。例如：DrawBox();//全局函数 box->Draw();//类的成员函数 【规则3-1-8】用正确的反义词组命名具有互斥意义的变量或相反动作的函数等。例如：int minValue; int maxValue;int SetValue(„); int GetValue(„); 【建议3-1-1】尽量避免名字中出现数字编号，如Value1,Value2等，除非逻辑上的确需要编号。 12 / 20 这是为了防止程序员偷懒，不肯为命名动脑筋而导致产生无意义的名字（因为用数字编号最省事）。 3.2简单的Windows应用程序命名规则 【规则3-2-1】类名和函数名用大写字母开头的单词组合而成。例如：class Node;//类名 class LeafNode;//类名 voidDraw(void);//函数名 voidSetValue(int value); //函数名 【规则3-2-2】变量和参数用小写字母开头的单词组合而成。例如： BOOL flag; intdrawMode; 【规则3-2-3】常量全用大写的字母，用下划线分割单词。例如： const int MAX = 100; const int MAX_LENGTH = 100; 【规则3-2-4】静态变量加前缀s_（表示static）。例如： void Init(„) { static int s_initValue; //静态变量 „ 13 / 20 } 【规则3-2-5】如果不得已需要全局变量，则使全局变量加前缀g_（表示global）。例如： int g_howManyPeople; //全局变量 int g_howMuchMoney; //全局变量 【规则3-2-6】类的数据成员加前缀m_（表示member），这样可以避免数据成员与成员函数的参数同名。例如： void Object::SetValue(int width, int height) { m_width = width; m_height = height; } 【规则3-2-7】为了防止某一软件库中的一些标识符和其它软件库中的冲突，可以为各种标识符加上能反映软件性质的前缀。例如三维图形标准OpenGL的所有库函数均以gl开头，所有常量（或宏定义）均以GL开头。 第4章表达式和基本语句 4.1运算符的优先级C语言的运算符有数十个，运算符的优先级与结合律。注意一元运算符+-*的优先级高于对应的二元运算符。 【规则4-1-1】如果代码行中的运算符比较多，用括号确定表达式的操作顺序，避免使用默认的优先级。 14 / 20 由于将表4-1熟记是比较困难的，为了防止产生歧义并提高可读性，应当用括号确定表达式的操作顺序。例如： word = (high << 8) | low if ((a | b) && (a & c)) 4.2复合表达式 如a = b = c = 0这样的表达式称为复合表达式。允许复合表达式存在的理由是：（1）书写简洁；（2）可以提高编译效率。但要防止滥用复合表达式。 【规则4-2-1】不要编写太复杂的复合表达式。例如：i = a >= b && c < d && c + f <=g + h ; //复合表达式过于复杂 【规则4-2-2】不要有多用途的复合表达式。例如：d = (a = b + c) + r ;该表达式既求a值又求d值。应该拆分为两个独立的语句：a = b + c; d = a + r; 4.3 if语句 if语句是C语言中最简单、最常用的语句，然而很多程序员用隐含错误的方式写if语句。 本节以“与零值比较”为例，展开讨论。 4.3.1布尔变量与零值比较 【规则4-3-1】不可将布尔变量直接与TRUE、FALSE或者1、0进行比较。根据布尔类型的语义，零值为“假”（记为FALSE），任何非零值都是“真”（记为TRUE）。TRUE的值究竟是什么并没有统一的标准。假设布尔变量名字为flag，它与零值比较的标准if语句如下： 15 / 20 if (flag) //表示flag为真 if (!flag) //表示flag为假 4.3.2整型变量与零值比较 【规则4-3-2】应当将整型变量用“==”或“！=”直接与0比较。假设整型变量的名字为value，它与零值比较的标准if语句如下： if (value == 0) if (value != 0) 4.3.3浮点变量与零值比较 【规则4-3-3】不可将浮点变量用“==”或“！=”与任何数字比较。 千万要留意，无论是float还是double类型的变量，都有精度限制。所以一定要避免将浮点变量用“==”或“！=”与数字比较，应该设法转化成“>=”或“<=”形式。 假设浮点变量的名字为x，应当将 if (x == 0.0)//隐含错误的比较 转化为 if ((x>=-EPSINON) && (x<=EPSINON)) 其中EPSINON是允许的误差（即精度）。 4.3.4指针变量与零值比较 16 / 20 【规则4-3-4】应当将指针变量用“==”或“！=”与NULL比较。 指针变量的零值是“空”（记为NULL）。尽管NULL的值与0相同，但是两者意义不同。 假设指针变量的名字为p，它与零值比较的标准if语句如下： if (p == NULL) // p与NULL显式比较，强调p是指针变量 if (p != NULL) 4.5 for语句的循环控制变量 【规则4-5-1】不可在for循环体内修改循环变量，防止for循环失去控制。 【建议4-5-1】建议for语句的循环控制变量的取值采用“半开半闭区间”写法。 4.6 switch语句 【规则4-6-1】每个case语句的结尾不要忘了加break，否则将导致多个分支重叠（除非有意使多个分支重叠）。 【规则4-6-2】不要忘记最后那个default分支。即使程序真的不需要default处理，也应该保留语句default:break;这样做并非多此一举，而是为了防止别人误以为你忘了default处理。 4.7 goto语句 自从提倡结构化设计以来，goto就成了有争议的语句。首先，由于goto语句可以灵活跳转，如果不加限制，它的确会破坏结构化设计风格。其次，goto语句经常带来错误或隐患。它可能跳过了某些对象的构造、变量的初始化、重要的计算等语句，例如：goto state; String s1, s2; //被goto跳过 int sum = 0; //被goto跳过 17 / 20 ⋯ state: ⋯ 如果编译器不能发觉此类错误，每用一次goto语句都可能留下隐患。 很多人建议废除C的goto语句，以绝后患。但实事求是地说，错误是程序员自己造成的，不是goto的过错。goto语句至少有一处可显神通，它能从多重循环体中咻地一下子跳到外面，用不着写很多次的break语句; 第5章常量 5.1常量 【规则5-1-1】尽量使用含义直观的常量来表示那些将在程序中多次出现的数字或字符串。例如：#defineMAX100/*C语言的宏常量*/ const intMAX = 100;//const常量 const floatPI = 3.14159; //const常量 5.3常量定义规则 【规则5-3-1】需要对外公开的常量放在头文件中，不需要对外公开的常量放在定义文件的头部。为便于管理，可以把不同模块的常量集中存放在一个公共的头文件中。 【规则5-3-2】如果某一常量与其它常量密切相关，应在定义中包含这种关系，而不应给出一些孤立的值。例如： 18 / 20 constfloatRADIUS = 100; constfloatDIAMETER = RADIUS * 2; 第6章函数设计 6.1参数的规则 【规则6-1-1】参数的书写要完整，不要贪图省事只写参数的类型而省略参数名字。如果函数没有参数，则用void填充。 【规则6-1-2】参数命名要恰当，顺序要合理。 【规则6-1-3】如果参数是指针，且仅作输入用，则应在类型前加const，以防止该指针在函数体内被意外修改。 【规则6-1-4】如果输入参数以值传递的方式传递对象，则宜改用“const &”方式来传递，这样可以省去临时对象的构造和析构过程，从而提高效率。² 【建议6-1-1】避免函数有太多的参数，参数个数尽量控制在5个以内。如果参数太多，在使用时容易将参数类型或顺序搞错。² 【建议6-1-2】尽量不要使用类型和数目不确定的参数。C标准库函数printf是采用不确定参数的典型代表，其原型为： int printf(const chat *format[, argument]⋯); 这种风格的函数在编译时丧失了严格的类型安全检查。 6.2返回值的规则 19 / 20 【规则6-2-1】不要省略返回值的类型。 C语言中，凡不加类型说明的函数，一律自动按整型处理。这样做不会有什么好处，却容易被误解为void类型。 【规则6-2-2】函数名字与返回值类型在语义上不可冲突。 【规则6-2-3】不要将正常值和错误标志混在一起返回。正常值用输出参数获得，而错误标志用return语句返回。 【建议6-2-1】有时候函数原本不需要返回值，但为了增加灵活性如支持链式表达，可以附加返回值。例如字符串拷贝函数strcpy的原型： char *strcpy(char *strDest，const char *strSrc); strcpy 函数将strSrc拷贝至输出参数strDest中，同时函数的返回值又是strDest。这样做并非多此一举，可以获得如下灵活性： char str[20]; intlength = strlen( strcpy(str,“Hello World”) ); 【建议6-2-2】如果函数的返回值是一个对象，有些场合用“引用传递”替换“值传递”可以提高效率。而有些场合只能用“值传递”而不能用“引用传递”，否则会出错。 20 / 20 因篇幅问题不能全部显示，请点此查看更多更全内容