《C语言格式书写规范》由会员分享，可在线阅读，更多相关《C语言格式书写规范（21页珍藏版）》请在金锄头文库上搜索。
1、-C语言书写规指南第1章文件构造每个C程序通常分为两个文件。一个文件用于保存程序的声明declaration，称为头文件。另一个文件用于保存程序的实现implementation，称为定义definition文件。C程序的头文件以.h为后缀，C程序的定义文件以.c为后缀。1.1和版本的声明和版本的声明位于头文件和定义文件的开头参见例如1-1，主要容有：1信息。2文件名称，标识符，摘要。3当前版本号，作者/修改者，完成日期。4版本历史信息。/*Copyright(c)2001,大学物理学院无线电*Allrightsreserved.*文件名称：filename.h*文件标识：*摘要：简要描述本文
2、件的容*当前版本：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
3、filename.h格式来引用非标准库的头文件编译器将从用户的工作目录开场搜索。【规则1-2-4】 #include后面使用TAB键控制排版。【规则1-2-5】头文件中只存放声明而不存放定义【规则1-2-6】全局变量在头文件中声明,在.c文件中定义 .h e*ternintvalue; 声明。.c intvalue=0*10; 定义。【规则1-2-7】局部变量在.c中定义(static)unsigned intvalue; 定义。/和版本声明见例如1-1，此处省略。#ifndefSCL_SPI_H/防止SCL_SPI.h被重复引用#defineSCL_SPI_H#include/引用标准库的头
4、文件#includeSCL_CAN.h/引用非标准库的头文件voidFunction1();/全局函数声明e*ternunsignintvalue;/全局变量声明#endif例如1-2C头文件的构造1.3定义文件的构造定义文件有三局部容：1定义文件开头处的和版本声明参见例如1-1。2对一些头文件的引用。3程序的实现体包括数据和代码。假设定义文件的名称为SCL_SPI.c，定义文件的构造参见例如1-3。/和版本声明见例如1-1，此处省略。#includeSCL_SPI.h/引用头文件/全局变量定义unsign intvalue = 0*10;/全局函数的实现体voidFunction1()例如1
5、-3C定义文件的构造1.4头文件的作用早期的编程语言如Basic、Fortran没有头文件的概念，C语言的初学者虽然会用使用头文件，但常常不明其理。这里对头文件的作用略作解释：1通过头文件来调用库功能。在很多场合，源代码不便或不准向用户公布，只要向用户提供头文件和二进制的库即可。用户只需要按照头文件中的接口声明来调用库功能，而不必关心接口怎么实现的。编译器会从库中提取相应的代码。2头文件能加强类型平安检查。如果*个接口被实现或被使用时，其方式与头文件中的声明不一致，编译器就会指出错误，这一简单的规则能大大减轻程序员调试、改错的负担。1.5目录构造如果一个软件的头文件数目比拟多如超过十个，通常应
6、将头文件和定义文件分别保存于不同的目录，以便于维护。例如可将头文件保存于include目录，将定义文件保存于source目录可以是多级目录。如果*些头文件是私有的，它不会被用户的程序直接引用，则没有必要公开其声明。为了加强信息隐藏，这些私有的头文件可以和定义文件存放于同一个目录。第2章程序的版式版式虽然不会影响程序的功能，但会影响可读性。程序的版式追求清晰、美观，是程序风格的重要构成因素。可以把程序的版式比喻为书法。好的书法可让人对程序一目了然，看得兴致勃勃。差的程序书法如螃蟹爬行，让人看得索然无味，更令维护者烦恼有加。请程序员们学习程序的书法，弥补大学计算机教育的漏洞，实在很有必要。2.1空
7、行空行起着分隔程序段落的作用。空行得体不过多也不过少将使程序的布局更加清晰。空行不会浪费存，虽然打印含有空行的程序是会多消耗一些纸，但是值得。所以不要舍不得用空行。【规则2-1-1】在每个函数定义完毕之后都要加空行。参见例如2-1a【规则2-1-2】在一个函数体，逻揖上密切相关的语句之间不加空行，其它地方应加空行分隔。参见例如2-1b. z.-/空行voidFunction1()/空行voidFunction2()例如2-1(a)函数之间的空行/空行while(condition)statement1;/空行if(condition)statement2;elsestatement3;/空行s
8、tatement4;例如2-1(b)函数部的空行2.2代码行【规则2-2-1】一行代码只做一件事情，如只定义一个变量，或只写一条语句。这样的代码容易阅读，并且方便于写注释。【规则2-2-2】if、for、while、do等语句自占一行，执行语句不得紧跟其后。不管执行语句有多少都要加。这样可以防止书写失误。例如2-2a为风格良好的代码行，例如2-2b为风格不良的代码行。intwidth;/宽度intheight;/高度intdepth;/深度中间使用TAB键控制距离intwidth,height,depth;/宽度高度深度* =a+b; /等号左右用空格控制距离y=c+d;z=e+f;* = a
9、+b;y=c+d;z=e+f;if(widthheight)/左右用空格控制距离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;I10;I+)/过多的空格* =aba:b;/
10、良好的风格*=aFunction();/不要写成b-Function();例如2-3代码行的空格2.4对齐【规则2-4-1】程序的分界符和应独占一行并且位于同一列，同时与引用它们的语句左对齐。【规则2-4-2】之的代码块在右边一个TAB键处左对齐。例如2-4a为风格良好的对齐，例如2-4b为风格不良的对齐。voidFunction(int*)/programcodeVoidFunction(int*)/programcodeif(condition)/programcodeelse/programcodeif(condition)/programcodeelse/programcodefor(initialization;condition;update)/programcodefor(initialization;condition;update)/programcodewhile(condition)/programcodewhile(condition)
