2022年C语言格式书写规范 .pdf

C 语言书写规范指南第 1 章文件结构每个 C程序通常分为两个文件。一个文件用于保存程序的声明（declaration），称为头文件。另一个文件用于保存程序的实现（implementation），称为定义（definition）文件。C程序的头文件以“.h ”为后缀， C程序的定义文件以“.c ”为后缀。1.1 版权和版本的声明版权和版本的声明位于头文件和定义文件的开头（参见示例1-1 ），主要内容有：（1）版权信息。（2）文件名称，标识符，摘要。（3）当前版本号，作者/ 修改者，完成日期。（4）版本历史信息。/* *Copyright(c)2001,吉林大学物理学院无线电*Allrightsreserved. * * 文件名称：filename.h* 文件标识：* 摘要：简要描述本文件的内容* * 当前版本：1.1* 作者：输入作者（或修改者）名字* 完成日期：2007年7月20日* * 取代版本：1.0* 原作者：输入原作者（或修改者）名字* 完成日期：2007年5月10日*/ 示例 1-1版权和版本的声明名师资料总结 - - -精品资料欢迎下载 - - - - - - - - - - - - - - - - - - 名师精心整理 - - - - - - - 第 1 页，共 26 页 - - - - - - - - - 1.2 头文件的结构头文件由三部分内容组成：（1）头文件开头处的版权和版本声明（参见示例1-1 ）。（2）预处理块。（3）函数和类结构声明等。假设头文件名称为SCL_SPI.h，头文件的结构参见示例1-2。【规则 1-2-1 】为了防止头文件被重复引用，应当用#ifndef/#define/#endif结构产生预处理块。【规则 1-2-2 】用 #include 格式来引用标准库的头文件（编译器将从标准库目录开始搜索）。【规则 1-2-3 】用 #include “filename.h ” 格式来引用非标准库的头文件（编译器将从用户的工作目录开始搜索）。【规则 1-2-4 】#include 后面使用 TAB 键控制排版。【规则 1-2-5 】头文件中只存放“声明”而不存放“定义”【规则 1-2-6 】全局变量在头文件中声明, 在.c 文件中定义.h extern in tvalue; 声明。.c in tvalue=0 x10; 定义。【规则 1-2-7 】局部变量在 .c 中定义(static)unsigned in tvalue; 定义。/ 版权和版本声明见示例1-1 ，此处省略。#ifndef SCL_SPI_H /防止 SCL_SPI.h被重复引用#define SCL_SPI_H#include /引用标准库的头文件,#include “SCL_CAN.h ”/ 引用非标准库的头文件,void Function1(,);/全局函数声明,extern unsign int value;/全局变量声明#endif 示例 1-2C头文件的结构1.3 定义文件的结构定义文件有三部分内容：（1）定义文件开头处的版权和版本声明（参见示例1-1）。（2）对一些头文件的引用。（3）程序的实现体（包括数据和代码）。名师资料总结 - - -精品资料欢迎下载 - - - - - - - - - - - - - - - - - - 名师精心整理 - - - - - - - 第 2 页，共 26 页 - - - - - - - - - 假设定义文件的名称为SCL_SPI.c，定义文件的结构参见示例1-3。/ 版权和版本声明见示例1-1 ，此处省略。#include “ SCL_SPI.h” / 引用头文件,/ 全局变量定义unsign int value = 0 x10; / 全局函数的实现体void Function1(,) , 示例 1-3C定义文件的结构1.4 头文件的作用早期的编程语言如Basic 、Fortran 没有头文件的概念，C语言的初学者虽然会用使用头文件，但常常不明其理。这里对头文件的作用略作解释：（1）通过头文件来调用库功能。在很多场合，源代码不便（或不准）向用户公布，只要向用户提供头文件和二进制的库即可。用户只需要按照头文件中的接口声明来调用库功能，而不必关心接口怎么实现的。编译器会从库中提取相应的代码。（2）头文件能加强类型安全检查。如果某个接口被实现或被使用时，其方式与头文件中的声明不一致，编译器就会指出错误，这一简单的规则能大大减轻程序员调试、改错的负担。1.5 目录结构如果一个软件的头文件数目比较多（如超过十个），通常应将头文件和定义文件分别保存于不同的目录，以便于维护。例如可将头文件保存于include 目录，将定义文件保存于source目录（可以是多级目录）。如果某些头文件是私有的，它不会被用户的程序直接引用，则没有必要公开其“声明”。为了加强信息隐藏，这些私有的头文件可以和定义文件存放于同一个目录。名师资料总结 - - -精品资料欢迎下载 - - - - - - - - - - - - - - - - - - 名师精心整理 - - - - - - - 第 3 页，共 26 页 - - - - - - - - - 第 2 章程序的版式版式虽然不会影响程序的功能，但会影响可读性。程序的版式追求清晰、美观，是程序风格的重要构成因素。可以把程序的版式比喻为“书法”。好的“书法”可让人对程序一目了然，看得兴致勃勃。差的程序“书法”如螃蟹爬行，让人看得索然无味，更令维护者烦恼有加。请程序员们学习程序的“书法”，弥补大学计算机教育的漏洞，实在很有必要。2.1 空行空行起着分隔程序段落的作用。空行得体（不过多也不过少）将使程序的布局更加清晰。空行不会浪费内存，虽然打印含有空行的程序是会多消耗一些纸张，但是值得。所以不要舍不得用空行。【规则 2-1-1 】在每个函数定义结束之后都要加空行。参见示例2-1 （a）【规则 2-1-2 】在一个函数体内，逻揖上密切相关的语句之间不加空行，其它地方应加空行分隔。参见示例 2-1 （b）/ 空行void Function1(,) , / 空行void Function2(,) , 示例 2-1(a) 函数之间的空行/ 空行while (condition) statement1; / 空行if (condition) statement2; else statement3; 名师资料总结 - - -精品资料欢迎下载 - - - - - - - - - - - - - - - - - - 名师精心整理 - - - - - - - 第 4 页，共 26 页 - - - - - - - - - / 空行statement4; 示例 2-1(b) 函数内部的空行2.2 代码行【规则 2-2-1 】一行代码只做一件事情，如只定义一个变量，或只写一条语句。这样的代码容易阅读，并且方便于写注释。【规则 2-2-2 】if 、for 、while 、do等语句自占一行，执行语句不得紧跟其后。不论执行语句有多少都要加 。这样可以防止书写失误。示例 2-2 （a）为风格良好的代码行，示例2-2 （b）为风格不良的代码行。intwidth;/宽度intheight;/高度intdepth;/深度中间使用 TAB 键控制距离intwidth,height,depth;/宽度高度深度x = a+b; /等号左右用空格控制距离y = c+d; z = e+f;x = a+b; y=c+d;z=e+f;if (width height)/ 左右用空格控制距离 dosomething();/ 使用 TAB 键控制距离if(width=”、“ =”、“ +”、“ * ”、“ % ”、“ & ”、“ | ”、“ ”这类操作符前后不加空格。【建议 2-3-1 】对于表达式比较长的for 语句和 if 语句，为了紧凑起见可以适当地去掉一些空格，如 for(i=0;i10;i+)和 if(a=b)&(c= 2000) / 良好的风格if(year=2000) / 不良的风格if (a=b) & (c=b&c=d) / 不良的风格for (i=0; i10; i+) / 良好的风格for(i=0;i10;i+) / 不良的风格for(I = 0; I 10; I+) / 过多的空格x = a b ? a : b; / 良好的风格x=aFunction(); / 不要写成 b - Function();示例 2-3 代码行内的空格2.4 对齐【规则 2-4-1 】程序的分界符和 应独占一行并且位于同一列，同时与引用它们的语句左对齐。【规则 2-4-2 】 之内的代码块在 右边一个 TAB 键处左对齐。示例 2-4 （a）为风格良好的对齐，示例2-4 （ b）为风格不良的对齐。名师资料总结 - - -精品资料欢迎下载 - - - - - - - - - - - - - - - - - - 名师精心整理 - - - - - - - 第 6 页，共 26 页 - - - - - - - - - void Function (int x) ,/programcodeVoid Function(intx) ,/programcodeif (condition) ,/programcode else ,/programcodeif(condition) ,/programcode else ,/programcodefor (initialization; condition; update) ,/programcodefor(initialization;condition;update) ,/programcodewhile (condition) ,/programcodewhile(condition) ,/programcode如果出现嵌套的，则使用缩进对齐，如： , , ,示例 2-4(a) 风格良好的对齐示例 2-4(b) 风格不良的对齐2.5 长行拆分【规则 2-5-1 】代码行最大长度宜控制在70至80个字符以内。代码行不要过长，否则眼睛看不过来，也不便于打印。【规则 2-5-2 】长表达式要在低优先级操作符处拆分成新行，操作符放在新行之首（以便突出操作符）。拆分出的新行要进行适当的缩进，使排版整齐，语句可读。if (very_longer_variable1 = very_longer_variable12) &(very_longer_variable3 = very_longer_variable14) 使用 TAB 键控制距离&(very_longer_variable5 Draw(); / 类的成员函数【规则 3-1-8 】用正确的反义词组命名具有互斥意义的变量或相反动作的函数等。例如：int minValue; int maxValue; 名师资料总结 - - -精品资料欢迎下载 - - - - - - - - - - - - - - - - - - 名师精心整理 - - - - - - - 第 10 页，共 26 页 - - - - - - - - - int SetValue(,);int GetValue(,);【建议 3-1-1 】尽量避免名字中出现数字编号，如Value1,Value2等，除非逻辑上的确需要编号。这是为了防止程序员偷懒，不肯为命名动脑筋而导致产生无意义的名字（因为用数字编号最省事）。3.2 简单的 Windows应用程序命名规则作者对“匈牙利”命名规则做了合理的简化，下述的命名规则简单易用，比较适合于Windows应用软件的开发。【规则 3-2-1 】类名和函数名用大写字母开头的单词组合而成。例如：class Node; / 类名class LeafNode; / 类名void Draw(void); / 函数名void SetValue(int value);/函数名【规则 3-2-2 】变量和参数用小写字母开头的单词组合而成。例如：BOOL flag; int drawMode; 【规则 3-2-3 】常量全用大写的字母，用下划线分割单词。例如：const int MAX = 100; const int MAX_LENGTH = 100; 【规则 3-2-4 】静态变量加前缀s_（表示 static）。例如：void Init(,) static int s_initValue;/静态变量, 【规则 3-2-5 】如果不得已需要全局变量，则使全局变量加前缀g_（表示 global ）。例如：int g_howManyPeople; / 全局变量int g_howMuchMoney; / / 全局变量【规则 3-2-6 】类的数据成员加前缀m_ （表示 member ），这样可以避免数据成员与成员函数名师资料总结 - - -精品资料欢迎下载 - - - - - - - - - - - - - - - - - - 名师精心整理 - - - - - - - 第 11 页，共 26 页 - - - - - - - - - 的参数同名。例如：Void Object:SetValue(int width, int height) m_width = width; m_height = height; 【规则 3-2-7 】为了防止某一软件库中的一些标识符和其它软件库中的冲突，可以为各种标识符加上能反映软件性质的前缀。例如三维图形标准OpenGL 的所有库函数均以gl 开头，所有常量（或宏定义）均以GL 开头。第 4 章表达式和基本语句表达式和语句都属于C的短语结构语法。它们看似简单，但使用时隐患比较多。本章归纳了正确使用表达式和语句的一些规则与建议。4.1 运算符的优先级C语言的运算符有数十个，运算符的优先级与结合律如表4-1 所示。注意一元运算符+ -* 的优先级高于对应的二元运算符。优先级运算符结合律从高到低排列() - .从左至右! + - （类型） sizeof + - * &从右至左* / %从左至右+ -从左至右从左至右 =从左至右= !=从左至右&从左至右从左至右|从左至右&从左至右|从右至左?:从右至左= += -= *= /= %= &= = |= =从左至右表4-1 运算符的优先级与结合律【规则 4-1-1 】如果代码行中的运算符比较多，用括号确定表达式的操作顺序，避免使用默认名师资料总结 - - -精品资料欢迎下载 - - - - - - - - - - - - - - - - - - 名师精心整理 - - - - - - - 第 12 页，共 26 页 - - - - - - - - - 的优先级。由于将表 4-1 熟记是比较困难的，为了防止产生歧义并提高可读性，应当用括号确定表达式的操作顺序。例如：word = (high=b&cd&c+f=g+h;/复合表达式过于复杂【规则 4-2-2 】不要有多用途的复合表达式。例如：d=(a=b+c)+r; 该表达式既求a值又求 d值。应该拆分为两个独立的语句：a = b + c; d = a + r; 【规则 4-2-3 】不要把程序中的复合表达式与“真正的数学表达式”混淆。例如：if(abc) /abc 是数学表达式而不是程序表达式并不表示if (ab)&(bc) 而是成了令人费解的if(ab)=”或“ =-EPSINON)&(x=EPSINON) 其中 EPSINON 是允许的误差（即精度）。4.3.4 指针变量与零值比较【规则 4-3-4 】应当将指针变量用“=”或“！ =”与 NULL 比较。指针变量的零值是“空”（记为NULL ）。尽管 NULL 的值与 0相同，但是两者意义不同。假设指针变量的名字为p，它与零值比较的标准if 语句如下：if(p=NULL) /p 与NULL 显式比较，强调p是指针变量if(p!=NULL) 不要写成if(p=0) / 容易让人误解 p是整型变量if(p!=0) 或者if(p) / 容易让人误解p是布尔变量if(!p) 4.3.5 对 if 语句的补充说明有时候我们可能会看到if(NULL=p) 这样古怪的格式。不是程序写错了，是程序名师资料总结 - - -精品资料欢迎下载 - - - - - - - - - - - - - - - - - - 名师精心整理 - - - - - - - 第 14 页，共 26 页 - - - - - - - - - 员为了防止将if(p=NULL) 误写成 if(p=NULL)，而有意把 p和NULL 颠倒。编译器认为if(p=NULL)是合法的，但是会指出if(NULL=p)是错误的，因为NULL 不能被赋值。程序中有时会遇到if/else/return的组合，应该将如下不良风格的程序if(condition) returnx; returny; 改写为if(condition) returnx; else returny; 或者改写成更加简练的return(condition?x:y); 4.4 循环语句的效率C循环语句中， for 语句使用频率最高，while 语句其次， do语句很少用。本节重点论述循环体的效率。提高循环体效率的基本办法是降低循环体的复杂性。【建议 4-4-1 】在多重循环中，如果有可能，应当将最长的循环放在最内层，最短的循环放在最外层，以减少CPU 跨切循环层的次数。例如示例4-4(b) 的效率比示例 4-4(a) 的高。for (row=0; row100; row+) for (col=0; col5; col+) fum = sum+arowcol; 示例 4-4(a) 低效率：长循环在最外层for (col=0; col5; col+) for (row=0; row100; row+) fum = sum+arowcol; 示例 4-4(b) 高效率：长循环在最内层名师资料总结 - - -精品资料欢迎下载 - - - - - - - - - - - - - - - - - - 名师精心整理 - - - - - - - 第 15 页，共 26 页 - - - - - - - - - 【建议 4-4-2 】如果循环体内存在逻辑判断，并且循环次数很大，宜将逻辑判断移到循环体的外面。示例4-4(c) 的程序比示例4-4(d) 多执行了 N-1次逻辑判断。并且由于前者老要进行逻辑判断，打断了循环“流水线”作业，使得编译器不能对循环进行优化处理，降低了效率。如果 N非常大，最好采用示例4-4(d) 的写法，可以提高效率。如果N 非常小，两者效率差别并不明显，采用示例4-4(c) 的写法比较好，因为程序更加简洁。for (i=0; iN; i+) if (condition DoSomething(); else DoOtherthing(); 表4-4(c) 效率低但程序简洁if(condition) for(i=0;iN;i+)DoSomething(); else for(i=0;iN;i+)DoOtherthing(); 表4-4(d) 效率高但程序不简洁4.5for 语句的循环控制变量【规则 4-5-1 】不可在 for 循环体内修改循环变量，防止for 循环失去控制。【建议 4-5-1 】建议 for 语句的循环控制变量的取值采用“半开半闭区间”写法。示例 4-5(a) 中的 x值属于半开半闭区间“0=xN”，起点到终点的间隔为N，循环次数为N 。示例 4-5(b) 中的 x值属于闭区间“0=x=N-1”，起点到终点的间隔为N-1，循环次数为N。相比之下，示例4-5(a) 的写法更加直观，尽管两者的功能是相同的。for(intx=0;xN;x+) , 示例 4-5(a) 循环变量属于半开半闭区间for(intx=0;x0) *pbTo+=*pbFrom+; returnpvTo; 示例 6-5复制不重叠的内存块assert 不是一个仓促拼凑起来的宏。为了不在程序的Debug版本和 Release 版本引起差别， assert 不应该产生任何副作用。所以assert 不是函数，而是宏。程序员可以把assert 看成一个在任何系统状态下都可以安全使用的无害测试手段。如果程序在assert 处终止了，并不是说含有该assert 的函数有错误，而是调用者出了差错，assert 可以帮助我们找到发生错误的原因。很少有比跟踪到程序的断言，却不知道该断言的作用更让人沮丧的事了。你化了很多时间，不是为了排除错误，而只是为了弄清楚这个错误到底是什么。有的时候，程序员偶尔还会设计出有错误的断言。所以如果搞不清楚断言检查的是什么，就很难判断错误是出现在程序中，还是出现在断言中。幸运的是这个问题很好解决，只要加上清晰的注释即可。这本是显而易见的事情，可是很少有程序员这样做。这好比一个人在森林里，看到树上钉着一块“危险”的大牌子。但危险到底是什么？树要倒？有废井？有野兽？除非告诉人们“危险”是什么，否则这个警告牌难以起到积极有效的作用。难以理解的断言常常被程序员忽略，甚至被删除。【规则 6-5-1 】使用断言捕捉不应该发生的非法情况。不要混淆非法情况与错误情况之间的区别，后者是必然存在的并且是一定要作出处理的。【规则 6-5-2 】在函数的入口处，使用断言检查参数的有效性（合法性）。【建议 6-5-1 】在编写函数时，要进行反复的考查，并且自问：“我打算做哪些假定？”一旦确定了的假定，就要使用断言对假定进行检查。【建议 6-5-2 】一般教科书都鼓励程序员们进行防错设计，但要记住这种编程风格可能会隐瞒错误。当进行防错设计时，如果“不可能发生”的事情的确发生了，则要使用断言进行报警。6.6 引用与指针的比较引用是 C+ 中的概念，初学者容易把引用和指针混淆一起。一下程序中，n是m 的一个引用名师资料总结 - - -精品资料欢迎下载 - - - - - - - - - - - - - - - - - - 名师精心整理 - - - - - - - 第 24 页，共 26 页 - - - - - - - - - （reference ）， m 是被引用物（ referent）。int m; int &n=m; n相当于 m 的别名（绰号），对n的任何操作就是对m 的操作。例如有人名叫王小毛，他的绰号是“三毛”。说“三毛”怎么怎么的，其实就是对王小毛说三道四。所以n既不是 m 的拷贝，也不是指向m 的指针，其实n就是 m 它自己。引用的一些规则如下：（1）引用被创建的同时必须被初始化（指针则可以在任何时候被初始化）。（2）不能有 NULL 引用，引用必须与合法的存储单元关联（指针则可以是NULL ）。（3）一旦引用被初始化，就不能改变引用的关系（指针则可以随时改变所指的对象）。以下示例程序中， k被初始化为 i 的引用。语句 k=j 并不能将 k修改成为 j 的引用，只是把 k的值改变成为 6。由于 k是i 的引用，所以i 的值也变成了 6。int i=5; int j=6; int &k=i; k=j; /k 和i 的值都变成了 6; 上面的程序看起来象在玩文字游戏，没有体现出引用的价值。引用的主要功能是传递函数的参数和返回值。C+语言中，函数的参数和返回值的传递方式有三种：值传递、指针传递和引用传递。以下是“值传递”的示例程序。由于Func1函数体内的 x是外部变量 n的一份拷贝，改变x的值不会影响 n, 所以 n的值仍然是 0。void Func1(int x) x=x+10; ,intn=0; Func1(n); cout“n=”nendl;/n=0 以下是“指针传递”的示例程序。由于Func2函数体内的 x是指向外部变量n的指针，改变该指针的内容将导致n的值改变，所以n的值成为 10。void Func2(int *x) (*x)=(*x)+10; ,int n=0; Func2(&n); cout“n=”nendl;/n=10 以下是“引用传递”的示例程序。由于Func3函数体内的 x是外部变量 n的引用， x 和n是同一个东西，改变x等于改变 n，所以 n的值成为 10。名师资料总结 - - -精品资料欢迎下载 - - - - - - - - - - - - - - - - - - 名师精心整理 - - - - - - - 第 25 页，共 26 页 - - - - - - - - - void Func3(int &x) x=x+10; ,int n=0; Func3(n); cout“n=”nendl;/n=10 对比上述三个示例程序，会发现“引用传递”的性质象“指针传递”，而书写方式象“值传递”。实际上“引用”可以做的任何事情“指针”也都能够做，为什么还要“引用”这东西？答案是“用适当的工具做恰如其分的工作”。指针能够毫无约束地操作内存中的如何东西，尽管指针功能强大，但是非常危险。就象一把刀，它可以用来砍树、裁纸、修指甲、理发等等，谁敢这样用？如果的确只需要借用一下某个对象的“别名”，那么就用“引用”，而不要用“指针”，以免发生意外。比如说，某人需要一份证明，本来在文件上盖上公章的印子就行了，如果把取公章的钥匙交给他，那么他就获得了不该有的权利。名师资料总结 - - -精品资料欢迎下载 - - - - - - - - - - - - - - - - - - 名师精心整理 - - - - - - - 第 26 页，共 26 页 - - - - - - - - -