C语言格式书写规范.docx

C语言格式书写规范.docx

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

C语言格式书写规范

C语言书写规范指南

第1章文件结构

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

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

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

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

1、1版权与版本的声明

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

（1）版权信息。

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

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

（4）版本历史信息。

/*

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

*Allrightsreserved、

*

*文件名称:

*文件标识:

*摘要:

简要描述本文件的内容

*

*当前版本:

1、1

*作者:

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

*完成日期:

2007年7月20日

*

*取代版本:

1、0

*原作者:

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

*完成日期:

2007年5月10日

*/

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

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“”格式来引用非标准库的头文件（编译器将从用户的工作目录开始搜索）。

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

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

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

、hexternintvalue;声明。

、cintvalue=0x10;定义。

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

//版权与版本声明见示例1-1,此处省略。

#ifndefSCL_SPI_H//防止SCL_SPI、h被重复引用

#defineSCL_SPI_H

#include//引用标准库的头文件

…

#include“SCL_CAN、h”//引用非标准库的头文件

…

voidFunction1（…）;//全局函数声明

…

externunsignintvalue;//全局变量声明

#endif

示例1-2C头文件的结构

1、3定义文件的结构

定义文件有三部分内容:

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

（2）对一些头文件的引用。

（3）程序的实现体（包括数据与代码）。

假设定义文件的名称为SCL_SPI、c,定义文件的结构参见示例1-3。

//版权与版本声明见示例1-1,此处省略。

#include“SCL_SPI、h”//引用头文件

…

//全局变量定义

unsignintvalue=0x10;

//全局函数的实现体

voidFunction1（…）

{

…

}

示例1-3C定义文件的结构

1、4头文件的作用

早期的编程语言如Basic、Fortran没有头文件的概念,C语言的初学者虽然会用使用头文件,但常常不明其理。

这里对头文件的作用略作解释:

（1）通过头文件来调用库功能。

在很多场合,源代码不便（或不准）向用户公布,只要向用户提供头文件与二进制的库即可。

用户只需要按照头文件中的接口声明来调用库功能,而不必关心接口怎么实现的。

编译器会从库中提取相应的代码。

（2）头文件能加强类型安全检查。

如果某个接口被实现或被使用时,其方式与头文件中的声明不一致,编译器就会指出错误,这一简单的规则能大大减轻程序员调试、改错的负担。

1、5目录结构

如果一个软件的头文件数目比较多（如超过十个）,通常应将头文件与定义文件分别保存于不同的目录,以便于维护。

例如可将头文件保存于include目录,将定义文件保存于source目录（可以就是多级目录）。

如果某些头文件就是私有的,它不会被用户的程序直接引用,则没有必要公开其“声明”。

为了加强信息隐藏,这些私有的头文件可以与定义文件存放于同一个目录。

第2章程序的版式

版式虽然不会影响程序的功能,但会影响可读性。

程序的版式追求清晰、美观,就是程序风格的重要构成因素。

可以把程序的版式比喻为“书法”。

好的“书法”可让人对程序一目了然,瞧得兴致勃勃。

差的程序“书法”如螃蟹爬行,让人瞧得索然无味,更令维护者烦恼有加。

请程序员们学习程序的“书法”,弥补大学计算机教育的漏洞,实在很有必要。

2、1空行

空行起着分隔程序段落的作用。

空行得体（不过多也不过少）将使程序的布局更加清晰。

空行不会浪费内存,虽然打印含有空行的程序就是会多消耗一些纸张,但就是值得。

所以不要舍不得用空行。

【规则2-1-1】在每个函数定义结束之后都要加空行。

参见示例2-1（a）

【规则2-1-2】在一个函数体内,逻揖上密切相关的语句之间不加空行,其它地方应加空行分隔。

参见示例2-1（b）

//空行

voidFunction1（…）

{

…

}

//空行

voidFunction2（…）

{

…

}

示例2-1（a）函数之间的空行

//空行

while（condition）

{

statement1;

//空行

if（condition）

{

statement2;

}

else

{

statement3;

}

//空行

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

{

dosomething（）;//使用TAB键控制距离

}

if（width

for（initialization;condition;update）

{

dosomething（）;//使用TAB键控制距离

}

//空行

other（）;

for（initialization;condition;update）

dosomething（）;

other（）;

示例2-2（a）风格良好的代码行示例2-2（b）风格不良的代码行

【建议2-2-1】尽可能在定义变量的同时初始化该变量（就近原则）

如果变量的引用处与其定义处相隔比较远,变量的初始化很容易被忘记。

如果引用了未被初始化的变量,可能会导致程序错误。

本建议可以减少隐患。

例如

intwidth=10;//定义并初绐化width

intheight=10;//定义并初绐化height

intdepth=10;//定义并初绐化depth

使用TAB键控制距离

2、3代码行内的空格

z【规则2-3-1】关键字之后要留空格。

象const、virtual、inline、case等关键字之后至少要留一个空格,否则无法辨析关键字。

象if、for、while等关键字之后应留一个空格再跟左括号‘（’,以突出关键字。

z【规则2-3-2】函数名之后不要留空格,紧跟左括号‘（’,以与关键字区别。

z【规则2-3-3】‘（’向后紧跟,‘）’、‘,’、‘;’向前紧跟,紧跟处不留空格。

z【规则2-3-4】‘,’之后要留空格,如Function（x,y,z）。

如果‘;’不就是一行的结束符号,其后要留空格,如for（initialization;condition;update）。

z【规则2-3-5】赋值操作符、比较操作符、算术操作符、逻辑操作符、位域操作符,如“=”、“+=”“>=”、“<=”、“+”、“*”、“%”、“&&”、“||”、“<<”,“^”等二元操作符的前后应当加空格。

z【规则2-3-6】一元操作符如“!

”、“~”、“++”、“--”、“&”（地址运算符）等前后不加空格。

z【规则2-3-7】象“［］”、“、”、“->”这类操作符前后不加空格。

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

voidFunc1（intx,inty,intz）;//良好的风格

voidFunc1（intx,inty,intz）;//不良的风格

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

a:

b;//良好的风格

x=a

a:

b;//不好的风格

int*x=&y;//良好的风格

int*x=&y;//不良的风格

array[5]=0;//不要写成array[5]=0;

a、Function（）;//不要写成a、Function（）;

b->Function（）;//不要写成b->Function（）;

示例2-3代码行内的空格

2、4对齐

【规则2-4-1】程序的分界符‘{’与‘}’应独占一行并且位于同一列,同时与引用它们的语句左对齐。

【规则2-4-2】{}之内的代码块在‘{’右边一个TAB键处左对齐。

示例2-4（a）为风格良好的对齐,示例2-4（b）为风格不良的对齐。

voidFunction（intx）

{

…//programcode

}

VoidFunction（intx）{

…//programcode

}

if（condition）

{

…//programcode

}

else

{

…//programcode

}

if（condition）{

…//programcode

}

else{

…//programcode

}

for（initialization;condition;update）

{

…//programcode

}

for（initialization;condition;update）{

…//programcode

}

while（condition）

{

…//programcode

}

while（condition）{

…//programcode

}

如果出现嵌套的｛｝,则使用缩进对齐,如:

{

…

{

…

}

…

}

示例2-4（a）风格良好的对齐示例2-4（b）风格不良的对齐

2、5长行拆分

z【规则2-5-1】代码行最大长度宜控制在70至80个字符以内。

代码行不要过长,否则眼睛瞧不过来,也不便于打印。

z【规则2-5-2】长表达式要在低优先级操作符处拆分成新行,操作符放在新行之首（以便突出操作符）。

拆分出的新行要进行适当的缩进,使排版整齐,语句可读。

if（（very_longer_variable1>=very_longer_variable12）

&&（very_longer_variable3<=very_longer_variable14）使用TAB键控制距离

&&（very_longer_variable5<=very_longer_variable16））

{

dosomething（）;

}

VirtualCMatrixCMultiplyMatrix（CMatrixleftMatrix,

CMatrixrightMatrix）;使用TAB键控制距离

For（very_longer_initialization;

very_longer_condition;使用TAB键控制距离

very_longer_update）

{

dosomething（）;

}

示例2-5长行的拆分

2、6修饰符的位置

修饰符*与＆应该靠近数据类型还就是该靠近变量名,就是个有争议的活题。

若将修饰符*靠近数据类型,例如:

int*x;从语义上讲此写法比较直观,即x就是

int类型的指针。

上述写法的弊端就是容易引起误解,例如:

int*x,y;此处y容易被误解为指针变量。

虽然将x与y分行定义可以避免误解,但并不就是人人都愿意这样做。

【规则2-6-1】应当将修饰符*与＆紧靠变量名例如:

char*name;

int*x,y;//此处y不会被误解为指针

2、7注释

C语言的注释符为“/*…*/”。

C++语言中,程序块的注释常采用“/*…*/”,行注释一般采用“//…”。

注释通常用于:

（1）版本、版权声明;

（2）函数接口说明;

（3）重要的代码行或段落提示。

虽然注释有助于理解代码,但注意不可过多地使用注释。

参见示例2-6。

z【规则2-7-1】注释就是对代码的“提示”,而不就是文档。

程序中的注释不可喧宾夺主,注释太多了会让人眼花缭乱。

注释的花样要少。

z【规则2-7-2】如果代码本来就就是清楚的,则不必加注释。

否则多此一举,令人厌烦。

例如

i++;//i加1,多余的注释

z【规则2-7-3】边写代码边注释,修改代码同时修改相应的注释,以保证注释与代码的一致性。

不再有用的注释要删除。

z【规则2-7-4】注释应当准确、易懂,防止注释有二义性。

错误的注释不但无益反而有害。

z【规则2-7-5】尽量避免在注释中使用缩写,特别就是不常用缩写。

z【规则2-7-6】注释的位置应与被描述的代码相邻,可以放在代码的上方或右方,不可放在下方。

z【规则2-7-8】当代码比较长,特别就是有多重嵌套时,应当在一些段落的结束处加注释,便于阅读。

/*

*函数介绍:

*输入参数:

*输出参数:

*返回值:

*/

VoidFunction（floatx,floaty,floatz）

{

…

if（…）

{

…

while（…）

{

…

}//endofwhile

…

}//endofif

}

示例2-6程序的注释

第3章命名规则

比较著名的命名规则当推Microsoft公司的“匈牙利”法,该命名规则的主要思想就是

“在变量与函数名中加入前缀以增进人们对程序的理解”。

例如所有的字符变量均以ch为前缀,若就是指针变量则追加前缀p。

如果一个变量由ppch开头,则表明它就是指向字符指针的指针。

“匈牙利”法最大的缺点就是烦琐,例如

int

i,

j,

k;

float

x,

y,

z;

倘若采用“匈牙利”命名规则,则应当写成

intii,ij,ik;//前缀i表示int类型

floatfX,fY,fZ;//前缀f表示float类型如此烦琐的程序会让绝大多数程序员无法忍受。

据考察,没有一种命名规则可以让所有的程序员赞同,程序设计教科书一般都不指定命名规则。

命名规则对软件产品而言并不就是“成败悠关”的事,我们不要化太多精力试图发明世界上最好的命名规则,而应当制定一种令大多数项目成员满意的命名规则,并在项目中贯彻实施。

绝对杜绝汉语拼音命名法

3、1共性规则

本节论述的共性规则就是被大多数程序员采纳的,我们应当在遵循这些共性规则的前提下,再扩充特定的规则,如3、2节。

z【规则3-1-1】标识符应当直观且可以拼读,可望文知意,不必进行“解码”。

标识符最好采用英文单词或其组合,便于记忆与阅读。

切忌使用汉语拼音来命名。

程序中的英文单词一般不会太复杂,用词应当准确。

例如不要把CurrentValue写成

NowValue。

z【规则3-1-2】标识符的长度应当符合“min-length&&max-information”原则。

几十年前老ANSIC规定名字不准超过6个字符,现今的C不再有此限制。

一般来说,长名字能更好地表达含义,所以函数名、变量名、类名长达十几个字符不足为怪。

那么名字就是否越长约好？

不见得!

例如变量名maxval就比maxValueUntilOverflow好用。

单字符的名字也就是有用的,常见的如i,j,k,m,n,x,y,z等,它们通常可用作函数内的局部变量。

z【规则3-1-3】命名规则尽量与所采用的操作系统或开发工具的风格保持一致。

例如Windows应用程序的标识符通常采用“大小写”混排的方式,如AddChild。

而

Unix应用程序的标识符通常采用“小写加下划线”的方式,如add_child。

别把这两类风格混在一起用。

z【规则3-1-4】程序中不要出现仅靠大小写区分的相似的标识符。

例如:

intx,X;//变量x与X容易混淆

voidfoo（intx）;//函数foo与FOO容易混淆

voidFOO（floatx）;

z【规则3-1-5】程序中不要出现标识符完全相同的局部变量与全局变量,尽管两者的作用域不同而不会发生语法错误,但会使人误解。

z【规则3-1-6】变量的名字应当使用“名词”或者“形容词＋名词”。

例如:

floatvalue;

floatoldValue;

floatnewValue;

z【规则3-1-7】全局函数的名字应当使用“动词”或者“动词＋名词”（动宾词组）。

类的成员函数应当只使用“动词”,被省略掉的名词就就是对象本身。

例如:

DrawBox（）;//全局函数

box->Draw（）;//类的成员函数

z【规则3-1-8】用正确的反义词组命名具有互斥意义的变量或相反动作的函数等。

例如:

intminValue;

intmaxValue;

intSetValue（…）;

intGetValue（…）;

—【建议3-1-1】尽量避免名字中出现数字编号,如Value1,Value2等,除非逻辑上的确需要编号。

这就是为了防止程序员偷懒,不肯为命名动脑筋而导致产生无意义的名字（因为用数字编号最省事）。

3、2简单的Windows应用程序命名规则

作者对“匈牙利”命名规则做了合理的简化,下述的命名规则简单易用,比较适合于Windows应用软件的开发。

z【规则3-2-1】类名与函数名用大写字母开头的单词组合而成。

例如:

classNode;//类名

classLeafNode;//类名

voidDraw（void）;//函数名

voidSetValue（intvalue）;//函数名

z【规则3-2-2】变量与参数用小写字母开头的单词组合而成。

例如:

BOOLflag;

intdrawMode;

z【规则3-2-3】常量全用大写的字母,用下划线分割单词。

例如:

constintMAX=100;

constintMAX_LENGTH=100;

z【规则3-2-4】静态变量加前缀s_（表示static）。

例如:

voidInit（…）

{

staticints_initValue;//静态变量

…

}

z【规则3-2-5】如果不得已需要全局变量,则使全局变量加前缀g_（表示global）。

例如:

intg_howManyPeople;//全局变量

intg_howMuchMoney;//全局变量

z【规则3-2-6】类的数据成员加前缀m_（表示member）,这样可以避免数据成员与成员函数的参数同名。

例如:

VoidObject:

:

SetValue（intwidth,intheight）

{

m_width=width;

m_height=height;

}

z【规则3-2-7】为了防止某一软件库中的一些标识符与其它软件库中的冲突,可以为

各种标识符加上能反映软件性质的前缀。

例如三维图形标准OpenGL的所有库函数均以gl开头,所有常量（或宏定义）均以GL开头。

第4章表达式与基本语句

表达式与语句都属于C的短语结构语法。

它们瞧似简单,但使用时隐患比较多。

本章归纳了正确使用表达式与语句的一些规则与建议。

4、1运算符的优先级

C语言的运算符有数十个,运算符的优先级与结合律如表4-1所示。

注意一元运算符+-*的优先级高于对应的二元运算符。

优先级

运算符

结合律

从高

到低排列

（）[]->、

从左至右

!

~++--（类型）sizeof

+-*&

从右至左

*/%

从左至右

+-

从左至右

<<>>

从左至右

<<=>>=

从左至右

==!

=

从左至右

&

从左至右

^

从左至右

|

从左至右

&&

从左至右

||

从右至左

?

:

从右至左

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

|=<<=>>=

从左至右

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

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

由于将表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

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

例如:

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

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

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

a=b