实用的C语言编程规范精要.doc

实用的C语言编程规范  目 录 简介 3 1 代码编写总体原则 4 1.1 清晰第一 4 1.2 简洁为美 4 1.3 选择合适的风格，与代码原有风格保持一致 4 2 文件结构 5 2.1 文件信息说明 5 2.2 头文件的结构 5 2.3 函数编写规则 6 3 标示符的命名规则 8 4 文件命名规则 9 5 变量命名规则 10 6 函数命名规则 10 7 宏命名规则 10 8 变量 10 9 注释 12 10 排版与格式 14 11.对齐 16 12参数设计规则 17 13返回值的规则 18  简介： 在项目团队协作开发的情况下,编程时应该强调的一个重要方面是程序的易读性，在保证软件速度等性能指标能满足用户需求的情况下，能让其他程序员容易读懂你所编写的程序。若项目小组的所有开发人员都遵循统一的、鲜明的一套编程风格，可以让协作者、后继者和自己一目了然，在很短的时间内看清楚程序结构，理解设计的思路，大大提高代码的可读性、可重用性、程序健壮性、可移植性、可维护性，对彼此交流和协同开发将起到事半功倍的作用。 制定本编程规范的目的是为了提高软件开发效率及所开发软件的可维护性，提高软件的质量。本规范由程序风格、命名规范、注释规范、可移植性以及软件的模块化规范等部分组成。 用简单的方法去做复杂的事！！！  1 代码编写总体原则 1.1 清晰第一 Harold Abelson 和 Gerald Jay “编写程序应该以人为本，计算机第二。” ――Steve McConnell 1.2 简洁为美 简洁就是易于理解并且易于实现。代码越长越难于看懂，也越容易在修改时引入错误，写的代码越多，意味着出错的地方越多，也就意味着代码的可靠性越低。因此，我们提倡大家通过编写简洁明了的代码来提升代码可靠性。废弃的代码(没有被调用的函数和全局变量)要及时清除，重复代码应该尽可能提炼成函数。 1.3 选择合适的风格，与代码原有风格保持一致 产品所有人共同分享同一种风格所带来的好处，远远超出为了统一而付出的代价。在公司已有编码规范的指导下，审慎地编排代码以使代码尽可能清晰，是一项非常重要的技能。 2 文件结构 每个C程序通常分为两个文件。一个文件用于保存程序的声明（declaration），称为头文件。另一个文件用于保存程序的实现（implementation），称为定义（definition）文件。C程序的头文件以“.h”为后缀，C程序的定义文件以“.c”为后缀。 2.1 文件信息说明 文件信息声明位于头文件和定义文件的开头（参见示例1），主要内容有： 公司名称； 文件名称； 版权信息； 当前版本，作者/修改者，完成日期； 主要函数描述； 注意事项； 示例1 2.2 头文件的结构 头文件由三部分内容组成： 头文件开头处的文件信息说明(参见示例1)； 预处理块； 函数和类结构声明等。 原则2.2.1 为了防止头文件被重复引用，应当用ifndef/define/endif结构产生预处理块；单词间以下划线“_”连接，例如有头文件名称为“filesystem.h”，则定义如下：“#ifndef _FILE_SYSTEM_H_”。 原则2.2.2 用 #include filename.h 格式来引用标准库的头文件(编译器将从标准库目录开始搜索)。 原则2.2.3 用 #include “filename.h” 格式来引用非标准库的头文件(编译器将从用户的工作目录开始搜索)。 原则2.2.4 头文件中只存放“声明”而不存放“定义”。 原则2.2.5 头文件中应包含所有定义文件所定义的函数声明，如果一个头文件对应多个定义文件，则不同定义文件内实现的函数要分开声明，并作注释以解释所声明的函数从属于那一个定义文件。 原则2.2.6 .c/.h文件禁止包含用不到的头文件。很多系统中头文件包含关系复杂，开发人员为了省事起见，可能不会去一一钻研，直接包含一切想到的头文件，甚至有些产品干脆发布了一个god.h，其中包含了所有头文件，然后发布给各个项目组使用，这种只图一时省事的做法，导致整个系统的编译时间进一步恶化，并对后来人的维护造成了巨大的麻烦。 2.3 函数编写规则 函数设计的精髓：编写整洁函数，同时把代码有效组织起来。 整洁函数要求：代码简单直接、不隐藏设计者的意图、用干净利落的抽象和直截了当的控制语句将函数有机组织起来。 原则2.3.1 一个函数仅完成一件功能。 说明：一个函数实现多个功能给开发、使用、维护都带来很大的困难。将没有关联或者关联很弱的语句放到同一函数中，会导致函数职责不明确，代码混乱，难以理解，难以测试和改动。 延伸阅读材料：《敏捷软件开