C语言格式书写规范.docx

C语言格式书写规范.docx

《C语言格式书写规范.docx》由会员分享，可在线阅读，更多相关《C语言格式书写规范.docx（21页珍藏版）》请在冰豆网上搜索。

C语言格式书写规范

Preparedon22November2020

C语言格式书写规范

C语言书写规范指南

第1章文件结构

每个C程序通常分为两个文件。

一个文件用于保存程序的声明（declaration），称为头文件。

另一个文件用于保存程序的实现（implementation），称为定义（definition）文件。

C程序的头文件以“.h”为后缀，C程序的定义文件以“.c”为后缀。

版权和版本的声明

版权和版本的声明位于头文件和定义文件的开头（参见示例1-1），主要内容有：

（1）版权信息。

（2）文件名称，标识符，摘要。

（3）当前版本号，作者/修改者，完成日期。

（4）版本历史信息。

/*

*Copyright（c）2001,吉林大学物理学院无线电

*Allrightsreserved.

*

*文件名称：

*文件标识：

*摘要：

简要描述本文件的内容

*

*当前版本：

*作者：

输入作者（或修改者）名字

*完成日期：

2007年7月20日

*

*取代版本：

*原作者：

输入原作者（或修改者）名字

*完成日期：

2007年5月10日

*/

示例1-1版权和版本的声明

头文件的结构

头文件由三部分内容组成：

（1）头文件开头处的版权和版本声明（参见示例1-1）。

（2）预处理块。

（3）函数和类结构声明等。

假设头文件名称为，头文件的结构参见示例1-2。

【规则1-2-1】为了防止头文件被重复引用，应当用#ifndef/#define/#endif结构产生预处理块。

【规则1-2-2】用#include<>格式来引用标准库的头文件（编译器将从标准库目录开始搜索）。

【规则1-2-3】用#include“”格式来引用非标准库的头文件（编译器将从用户的工作目录开始搜索）。

【规则1-2-4】#include后面使用TAB键控制排版。

【规则1-2-5】头文件中只存放“声明”而不存放“定义”

【规则1-2-6】全局变量在头文件中声明,在.c文件中定义

.hexternintvalue;声明。

.cintvalue=0x10;定义。

【规则1-2-7】局部变量在.c中定义（static）unsignedintvalue;定义。

、“->”这类操作符前后不加空格。

【建议2-3-1】对于表达式比较长的for语句和if语句，为了紧凑起见可以适当地去掉一些空格，如for（i=0;i<10;i++）和if（（a<=b）&&（c<=d））

voidFunc1（intx,inty,intz）;

从左至右

!

~++--（类型）sizeof

+-*&

从右至左

*/%

从左至右

+-

从左至右

<<>>

从左至右

<<=>>=

从左至右

==!

=

从左至右

&

从左至右

^

从左至右

|

从左至右

&&

从左至右

||

从右至左

:

从右至左

=+=-=*=/=%=&=^=

|=<<=>>=

从左至右

表4-1运算符的优先级与结合律

【规则4-1-1】如果代码行中的运算符比较多，用括号确定表达式的操作顺序，避免使用默认的优先级。

由于将表4-1熟记是比较困难的，为了防止产生歧义并提高可读性，应当用括号确定表达式的操作顺序。

例如：

word=（high<<8）|low

if（（a|b）&&（a&c））

复合表达式

如a=b=c=0这样的表达式称为复合表达式。

允许复合表达式存在的理由是：

（1）书写简洁；

（2）可以提高编译效率。

但要防止滥用复合表达式。

【规则4-2-1】不要编写太复杂的复合表达式。

例如：

i=a>=b&&c

【规则4-2-2】不要有多用途的复合表达式。

例如：

d=（a=b+c）+r;

该表达式既求a值又求d值。

应该拆分为两个独立的语句：

a=b+c;

d=a+r;

【规则4-2-3】不要把程序中的复合表达式与“真正的数学表达式”混淆。

例如：

if（a

if（（a

而是成了令人费解的

if（（a

语句

if语句是C语言中最简单、最常用的语句，然而很多程序员用隐含错误的方式

写if语句。

本节以“与零值比较”为例，展开讨论。

布尔变量与零值比较

【规则4-3-1】不可将布尔变量直接与TRUE、FALSE或者1、0进行比较。

根据布尔类型的语义，零值为“假”（记为FALSE），任何非零值都是“真”（记为

TRUE）。

TRUE的值究竟是什么并没有统一的标准。

例如VisualC++将TRUE定义为1，

而VisualBasic则将TRUE定义为-1。

假设布尔变量名字为flag，它与零值比较的标准if语句如下：

if（flag）//表示flag为真

if（!

flag）//表示flag为假

其它的用法都属于不良风格，例如：

if（flag==TRUE）

if（flag==1）

if（flag==FALSE）

if（flag==0）

整型变量与零值比较

【规则4-3-2】应当将整型变量用“==”或“！

=”直接与0比较。

假设整型变量的名字为value，它与零值比较的标准if语句如下：

if（value==0）

if（value!

=0）

不可模仿布尔变量的风格而写成

if（value）//会让人误解value是布尔变量

if（!

value）

浮点变量与零值比较

【规则4-3-3】不可将浮点变量用“==”或“！

=”与任何数字比较。

千万要留意，无论是float还是double类型的变量，都有精度限制。

所以一定要避免将浮点变量用“==”或“！

=”与数字比较，应该设法转化成“>=”或“<=”形式。

假设浮点变量的名字为x，应当将

if（x==//隐含错误的比较转化为

if（（x>=-EPSINON）&&（x<=EPSINON））

其中EPSINON是允许的误差（即精度）。

指针变量与零值比较

【规则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）

对if语句的补充说明

有时候我们可能会看到if（NULL==p）这样古怪的格式。

不是程序写错了，是程序

员为了防止将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（conditionx:

y）;

循环语句的效率

C循环语句中，for语句使用频率最高，while语句其次，do语句很少用。

本节重点论述循环体的效率。

提高循环体效率的基本办法是降低循环体的复杂性。

【建议4-4-1】在多重循环中，如果有可能，应当将最长的循环放在最内层，最短的循环放在最外层，以减少CPU跨切循环层的次数。

例如示例4-4（b）的效率比示例4-4（a）的高。

for（row=0;row<100;row++）

{

for（col=0;col<5;col++）

{

fum=sum+a[row][col];

}

}

示例4-4（a）低效率：

长循环在最外层

for（col=0;col<5;col++）

{

for（row=0;row<100;row++）

{

fum=sum+a[row][col];

}

}

示例4-4（b）高效率：

长循环在最内层

【建议4-4-2】如果循环体内存在逻辑判断，并且循环次数很大，宜将逻辑判断移到循环体的外面。

示例4-4（c）的程序比示例4-4（d）多执行了N-1次逻辑判断。

并且由于前者老要进行逻辑判断，打断了循环“流水线”作业，使得编译器不能对循环进行优化处理，降低了效率。

如果N非常大，最好采用示例4-4（d）的写法，可以提高效率。

如果N非常小，两者效率差别并不明显，采用示例4-4（c）的写法比较好，因为程序更加简洁。

for（i=0;i

{

if（condition

{

DoSomething（）;

}

else

{

DoOtherthing（）;

}

}

表4-4（c）效率低但程序简洁

if（condition）

{

for（i=0;i

}

else

{

for（i=0;i

}

表4-4（d）效率高但程序不简洁

语句的循环控制变量

【规则4-5-1】不可在for循环体内修改循环变量，防止for循环失去控制。

【建议4-5-1】建议for语句的循环控制变量的取值采用“半开半闭区间”写法。

示例4-5（a）中的x值属于半开半闭区间“0=

示例4-5（b）中的x值属于闭区间“0=

相比之下，示例4-5（a）的写法更加直观，尽管两者的功能是相同的。

for（intx=0;x

{

…

}

示例4-5（a）循环变量属于半开半闭区间

for（intx=0;x<=N-1;x++）

{

…

}

示例4-5（b）循环变量属于闭区间

语句

switch是多分支选择语句，而if语句只有两个分支可供选择。

虽然可以用嵌套的if语句来实现多分支选择，但那样的程序冗长难读。

这是switch语句存在的理由。

switch语句的基本格式是：

switch（variable）

{

casevalue1:

{

…

break;

}

casevalue2:

{

…

break;

}

…

default:

{

…

break;

}

}

【规则4-6-1】每个case语句的结尾不要忘了加break，否则将导致多个分支重叠（除

非有意使多个分支重叠）。

【规则4-6-2】不要忘记最后那个default分支。

即使程序真的不需要default处理，也应该保留语句default:

break;这样做并非多此一举，而是为了防止别人误以为你忘了default处理。

语句

自从提倡结构化设计以来，goto就成了有争议的语句。

首先，由于goto语句可以灵活跳转，如果不加限制，它的确会破坏结构化设计风格。

其次，goto语句经常带来错误或隐患。

它可能跳过了某些对象的构造、变量的初始化、重要的计算等语句，例如：

gotostate;

Strings1,s2;//被goto跳过

intsum=0;//被goto跳过

…

state:

…

如果编译器不能发觉此类错误，每用一次goto语句都可能留下隐患。

很多人建议废除C的goto语句，以绝后患。

但实事求是地说，错误是程序员自己造成的，不是goto的过错。

goto语句至少有一处可显神通，它能从多重循环体中咻地一下子跳到外面，用不着写很多次的break语句;例如

{…

{…

{…

gotoerror;

}

}

}

error:

…

就象楼房着火了，来不及从楼梯一级一级往下走，可从窗口跳出火坑。

所以我们主张少用、慎用goto语句，而不是禁用。

第5章常量

常量是一种标识符，它的值在运行期间恒定不变。

C语言用#define来定义常量（称为宏常量）。

C++语言除了#define外还可以用const来定义常量（称为const常量）。

为什么需要常量

如果不使用常量，直接在程序中填写数字或字符串，将会有什么麻烦

（1）程序的可读性（可理解性）变差。

程序员自己会忘记那些数字或字符串是什么意思，用户则更加不知它们从何处来、表示什么。

（2）在程序的很多地方输入同样的数字或字符串，难保不发生书写错误。

（3）如果要修改数字或字符串，则会在很多地方改动，既麻烦又容易出错。

【规则5-1-1】尽量使用含义直观的常量来表示那些将在程序中多次出现的数字或字符串。

例如：

#defineMAX100/*C语言的宏常量*/

constintMAX=100;//C++语言的const常量

constfloatPI=;//C++语言的const常量

与#define的比较

C++语言可以用const来定义常量，也可以用#define来定义常量。

但是前者比后者有更多的优点：

（1）const常量有数据类型，而宏常量没有数据类型。

编译器可以对前者进行类型安全检查。

而对后者只进行字符替换，没有类型安全检查，并且在字符替换可能会产生意料不到的错误（边际效应）。

（2）有些集成化的调试工具可以对const常量进行调试，但是不能对宏常量进行调试。

【规则5-2-1】在C++程序中只使用const常量而不使用宏常量，即const常量完全取代宏常量。

常量定义规则

【规则5-3-1】需要对外公开的常量放在头文件中，不需要对外公开的常量放在定义文件的头部。

为便于管理，可以把不同模块的常量集中存放在一个公共的头文件中。

【规则5-3-2】如果某一常量与其它常量密切相关，应在定义中包含这种关系，而不

应给出一些孤立的值。

例如：

const

float

RADIUS=100;

const

float

DIAMETER=RADIUS*2;

第6章函数设计

函数是C程序的基本功能单元，其重要性不言而喻。

函数设计的细微缺点很容易导致该函数被错用，所以光使函数的功能正确是不够的。

本章重点论述函数的接口设计和内部实现的一些规则。

函数接口的两个要素是参数和返回值。

C语言中，函数的参数和返回值的传递方式有两种：

值传递（passbyvalue）和指针传递（passbypointer）。

C++语言中多了引用传递（passbyreference）。

由于引用传递的性质象指针传递，而使用方式却象值传递，初学者常常迷惑不解，容易引起混乱，请先阅读节“引用与指针的比较”。

参数的规则

【规则6-1-1】参数的书写要完整，不要贪图省事只写参数的类型而省略参数名字。

如果函数没有参数，则用void填充。

例如：

voidSetValue（intwidth,intheight）;//良好的风格

voidSetValue（int,int）;//不良的风格

floatGetValue（void）;//良好的风格

floatGetValue（）;//不良的风格

【规则6-1-2】参数命名要恰当，顺序要合理。

例如编写字符串拷贝函数StringCopy，它有两个参数。

如果把参数名字起为str1和

str2，例如

voidStringCopy（char*str1,char*str2）;

那么我们很难搞清楚究竟是把str1拷贝到str2中，还是刚好倒过来。

可以把参数名字起得更有意义，如叫strSource和strDestination。

这样从名字上就可以看出应该把strSource拷贝到strDestination。

还有一个问题，这两个参数那一个该在前那一个该在后参数的顺序要遵循程序员的习惯。

一般地，应将目的参数放在前面，源参数放在后面。

如果将函数声明为：

voidStringCopy（char*strSource,char*strDestination）;

别人在使用时可能会不假思索地写成如下形式：

charstr[20];

StringCopy（str,“HelloWorld”）;//参数顺序颠倒

【规则6-1-3】如果参数是指针，且仅作输入用，则应在类型前加const，以防止该指针在函数体内被意外修改。

例如：

voidStringCopy（char*strDestination，constchar*strSource）;

【规则6-1-4】如果输入参数以值传递的方式传递对象，则宜改用“const&”方式来传递，这样可以省去临时对象的构造和析构过程，从而提高效率。

【建议6-1-1】避免函数有太多的参数，参数个数尽量控制在5个以内。

如果参数太多，在使用时容易将参数类型或顺序搞错。

【建议6-1-2】尽量不要使用类型和数目不确定的参数。

C标准库函数printf是采用不确定参数的典型代表，其原型为：

intprintf（constchat*format[,argument]…）;

这种风格的函数在编译时丧失了严格的类型安全检查。

返回值的规则

【规则6-2-1】不要省略返回值的类型。

C语言中，凡不加类型说明的函数，一律自动按整型处理。

这样做不会有什么好处，却容易被误解为void类型。

C++语言有很严格的类型安全检查，不允许上述情况发生。

由于C++程序可以调用C函数，为了避免混乱，规定任何C++/C函数都必须有类型。

如果函数没有返回值，那么应声明为void类型。

【规则6-2-2】函数名字与返回值类型在语义上不可冲突。

违反这条规则的典型代表是C标准库函数getchar。

例如：

charc;

c=getchar（）;

if（c==EOF）

…

按照getchar名字的意思，将变量c声明为char类型是很自然的事情。

但不幸的是

getchar的确不是char类型，而是int类型，其原型如下：

intgetchar（void）;

由于c是char类型，取值范围是[-128，127]，如果宏EOF的值在char的取值范围之外，那么if语句将总是失败，这种“危险”人们一般哪里料得到！

导致本例错误的责任并不在用户，是函数getchar误导了使用者。

【规则6-2-3】不要将正常值和错误标志混在一起返回。

正常值用输出参数获得，而错误标志用return语句返回。

回顾上例，C标准库函数的设计者为什么要将getchar声明为令人迷糊的int类型呢

他会那么傻吗

在正常情况下，getchar的确返回单个字符。

但如果getchar碰到文件结束标志或发生读错误，它必须返回一个标志EOF。

为了区别于正常的字符，只好将EOF定义为负数

（通常为负1）。

因此函数getchar就成了int类型。

我们在实际工作中，经常会碰到上述令人为难的问题。

为了避免出现误解，我们应该将正常值和错误标志分开。

即：

正常值用输出参数获得，而错误标志用return语句返回。

函数getchar可以改写成BOOLGetChar（char*c）;

虽然gechar比GetChar灵活，例如putchar（getchar（））;但是如果getchar用错了，它的灵活性又有什么用呢

【建议6-2-1】有时候函数原本不需要返回值，但为了增加灵活性如支持链式表达，可以附加返回值。

例如字符串拷贝函数strcpy的原型：

char*strcpy（char*strDest，constchar*strSrc）;

strcpy函数将strSrc拷贝至输出参数strDest中，同时函数的返回值又是strDest。

这样做并非多此一举，可以获得如下灵活性：

charstr[20];

intlength=strlen（strcpy（str,“HelloWorld”））;

【建议6-2-2】如果函数的返回值是一个对象，有些场合用“引用传递”替换“值传递”可以提高效率。

而有些场合只能用“值传递”而不能用“引用传递”，否则会出错。

例如：

classString

{…

//赋值函数

String&operate=（constString&other）;

//相加函数，如果没有friend修饰则只许有一个右侧参数

friendStringoperate+（constString&s1,constString&s2）;

private:

char*m_data;

}

String的赋值函数operate=的实现如下：

String&String:

:

operate=（constString&other）

{

if（this==&other）

return*this;

deletem_data;

m_data=newchar[strlen+1];

strcpy（m_data,;

return*this;//返回的是*this的引用，无需拷贝过程

}

对于赋值函数，应当用“引用传递”的方式返回String对象。

如果用“值传递”的

方式，虽然功能仍然正确，但由于return语句要把*this拷贝到保存返回值的外部存储单元之中，增加了不必要的开销，降低了赋值函数的效率。

例如：

Stringa,b,c;

…

a=b;

//如果用“值传递”，将产生一次

*this

拷贝

a=b=c;

//如果用“值传递”，将产生两次

*this

拷贝

String的相加函数operate+的实现如下：

Stringoperate+（constString&s1,constString&s2）

{

Stringtemp;

;//是仅含‘\0’的字符串

=newchar[strlen+strlen+1];

strcpy,;

strcat,;

returntemp;

}

对于相加函数，应当用“值传递”的方式返回String对象。

如果改用“引用传递”，

那么函数返回值是一个指向局部对象temp的“引用”。

由于temp在函数结束时被自动销毁，将导致返回的“引用”无效。

例如：

c=a+b;

此时a+b并不返回期望值，c什么也得不到，流下了隐患。

函数内部实现的规则

不同功能的函数其内部实现各不相同，看起来似乎无法就“内部实现”达成一致的观点。

但根据经验，我们可以在函数体的“入口处”和“出口处”从严把关，从而提高函数的质量。

【规则6-3-1】在函数体的“入口处”，对参数的有效性进行检查。

很多程序错误是由非法参数引起的，我们应该充分理解并正确使用“断言”（assert）来防止此类错误。

详见节“使用断言”。

【规则6-3-2】在函数体的“出口处”，对return语句的正确性和效率进行检查。

如果函数有返回值，那么函数的“出口处”是return语句。

我们不要轻视return语句。

如果return语句写得不好，函数要么出错，要么效率低下。

注意事项如下：

（1）return语句不可返回指向“栈内存”的“指针”或者“引用”，因为该内存在函数体结束时被自动销毁。

例如

char*Func（void）

{

charstr[]=“helloworld”;//str的内存位于栈上

…

returnstr;//将导致错