实验室内部C语言编程规范V1.0解析.docVIP

实验室内部C编程规范 文件状态 文件标识： [] 草稿文件 当前版本： V [ √ ] 正式文件 作 者： 徐平 [ ] 更新文件 完成日期： 2009-11- 完成地点： 杭州电子科技大学自动化学院 版本历史 版 本 状 态 作 者 时 间 备 注 V0.草稿文件 徐平 2009-11-5～2009-11-徐平起草 V0.草稿文件 徐平 2009-11-～009-11-12 朱滔修改，徐平补充 V1.0 正式文件 徐平 2009-11-～009-11-17 朱滔增加typedef.h， 徐平补充 目 录 文件结构 程序排版 注释 命名规则 常量、变量和结构 基本语句 函数 内存管理 附录----------------------------------------------------------------------------------------------26 参考文献----------------------------------------------------------------------------------------27 第1章 文件结构 每个C程序通常分为两个文件。一个文件用于保存程序的声明（declaration）， 称为头文件，另一个文件用于保存程序的实现（implementation），称为定义（definition）文件。C程序的头文件以“.h”为后缀，C 程序的定义文件以“.c”为后缀。 1.1 版权和版本的声明 版权和版本的声明位于头文件和定义文件的开头（参见示例 1-1），主要内容有： （1）版权信息； （2）文件名称，作者，当前版本号，完成日期，文件功能描述； （3）版本历史信息。 示例1-1 版权和版本的声明 1.2 头文件的结构 头文件由三部分内容组成： 头文件开头处的版权和版本声明； 预处理块； 函数和结构声明等。 假设头文件名称为 filename.h，头文件的结构参见示例 1-2。 示例1-2 头文件的结构 【规则 1-1】为了防止头文件被重复引用，应当用 ifndef/define/endif 结构产生预处理块。 【规则 1-2】用 #include filename.h 格式来引用标准库的头文件（编译器将从标准库目录开始搜索）。 【规则 1-3】用 #include “filename.h” 格式来引用非标准库的头文件（编译器将从用户的工作目录开始搜索）。 【建议 1-1】头文件中只存放“声明”而不存放“定义”。 【建议 1-2】不提倡使用全局变量，尽量不要在头文件中出现象 extern int value 这类声明。1.3 定义文件的结构 定义文件有三部分内容： 1） 定义文件开头处的版权和版本声明（参见示例 1-1）； 2） 对一些头文件的引用； 3） 程序的实现体（包括数据和代码）。 假设定义文件的名称为 filename.h，定义文件的结构参见示例1-3。 示例1-3 定义文件的结构 1.4 头文件的作用 C 语言的初学者虽然会用使用头文件，但常常不明其理，这里对头文件的作用略作解释： 1）通过头文件来调用库功能。在很多场合，源代码不便（或不准）向用户公布，只要向用户提供头文件和二进制的库即可。用户只需要按照头文件中的接口声明来调用库功能，而不必关心接口怎么实现的。编译器会从库中提取相应的代码。 2）头文件能加强类型安全检查。如果某个接口被实现或被使用时，其方式与头文件中的声明不一致，编译器就会指出错误，这一简单的规则能大大减轻程序员调试、改错的负担。 1.5 目录结构 如果一个软件的头文件数目比较多（如超过十个），通常应将头文件和定义文件分别保存于不同的目录，以便于维护。 头文件保存于include目录，将定义文件保存于source目录（可以是多级目录）。 第2章 程序排版 2.1 空行 【规则 2-1】在每个类声明之后、每个函数定义结束之后都要加空行。参见示例2.1(a)。 【规则 2-2】在一个函数体内，逻揖上密切相关的语句之间不加空行，其它地方应加空行分隔。参见示例 2.1(b)。  示例2-1(a) 函数之间的空行 示例2-1(b) 函数内部的空行 // 空行 void function1(…) { … } // 空行 void function2(…) { … } // 空行 void function3(…) { … } // 空行 while (condition) { statement1;