c语言规范标准,C语言格式书写标准规范.doc

C语言书写规范指南

第1章文件结构

每个C程序通常分为两个文件。一个文件用于保留程序申明(declaration)，称为头文件。另一个文件用于保留程序实现(implementation)，称为定义(definition)文件。

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

1.1版权和版本申明

版权和版本申明在头文件和定义文件开头(参见示例1-1)，关键内容有：

(1)版权信息。

(2)文件名称，标识符，摘要。

(3)目前版本号，作者/修改者，完成日期。

(4)版本历史信息。

/*

*Copyright(c)20XX,吉林大学物理学院无线电

*Allrightsreserved.

*

*文件名称：filename.h

*文件标识：

*摘要：简明描述本文件内容

*

*目前版本：1.1

*作者：输入作者(或修改者)名字

*完成日期：20XX年7月20日

*

*替换版本：1.0

*原作者：输入原作者(或修改者)名字

*完成日期：20XX年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“filename.h”格式来引用非标准库头文件(编译器将从用户工作目录开始搜索)。

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

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

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

.h extern in tvalue; 申明。

.c in tvalue=0x10; 定义。

【规则1-2-7】局部变量在.c中定义 (static) unsigned in tvalue; 定义。

//版权和版本申明见示例1-1，此处省略。

#ifndefSCL_SPI_H //预防SCL_SPI.h被反复引用

#defineSCL_SPI_H

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

…

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

…

void Function1(…);//全局函数申明

…

extern unsign int value;//全局变量申明

#endif

示例1-2C头文件结构

1.3定义文件结构

定义文件有三部分内容：

(1)定义文件开头处版权和版本申明(参见示例1-1)。

(2)对部分头文件引用。

(3)程序实现体(包含数据和代码)。

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

//版权和版本申明见示例1-1，此处省略。

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

…

//全局变量定义

unsign int value = 0x10;

//全局函数实现体

void Function1(…)

{

…

}

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

1.4头文件作用

早期编程语言如Basic、Fortran没有头文件概念，C语言初学者即使会用使用头文件，但常常不明其理。这里对头文件作用略作解释：

(1)经过头文件来调用库功效。在很多场所，源代码不便(或不准)向用户公布，只要向用户提供头文件和二进制库即可。用户只需要根据头文件中接口申明来调用库功效，而无须关心接口怎么实现。编译器会从库中提取对应代码。

(2)头文件能加强类型安全检验。假如某个接口被实现或被使用时，其方法和头文件中申明不一致，编译器就会指犯错误，这一简单规则能大大减轻程序员调试、改错负担。

1.5目录结构

假如一个软件头文件数目比较多(如超出十个)，通常应将头文件和定义文件分别保留于不一样目录，方便于维护。

比如可将头文件保留于 include 目录，将定义文件保留于 source 目录(能够是多级目录)。

假如一些头文件是私有，它不会被用户程序直接引用，则没有必需公开其“申明”。为了加强信息隐藏，这些私有头文件能够和定义文件存放于同一个目录。

第2章程序版式

版式即使不会影响程序功效，但会影响可读性。程序版式追求清楚、美观，是程序风格关键组成原因。

能够把程序版式比方为“书法”。好“书法”可让人对程序一目了然，看得兴致勃勃。差程序“书法”如螃蟹爬行，让人看得索然无味，更令维护者烦