实用的c语言编程规范.pdfVIP

实用的 C语言编程规范 实用的 C 语言编程规范 2 / 21 目 录 简介 5 1 代码编写总体原则 6 1.1 清晰第一 6 1.2 简洁为美 6 1.3 选择合适的风格，与代码原有风格 保持一致 6 2 文件结构 7 2.1 文件信息说明 7 2.2 头文件的结构 7 2.3 函数编写规则 8 3 标示符的命名规则 10 4 文件命名规则 11 5 变量命名规则 12 6 函数命名规则 12 7 宏命名规则 12 8 变量 13 9 注释 14 10 排版与格式 16 11.对齐 18 12 参数设计规则 19 3 / 21 13 返回值的规则 20 4 / 21 简介 ： 在项目团队协作开发的情况下 ,编程时应该强调的一个重要方面 是程序的易读性， 在保证软件速度等性能指标能满足用户需求的情况 下，能让其他程序员容易读懂你所编写的程序。 若项目小组的所有开 发人员都遵循统一的、 鲜明的一套编程风格， 可以让协作者、 后继者 和自己一目了然，在很短的时间内看清楚程序结构， 理解设计的思路， 大大提高代码的可读性、可重用性、程序健壮性、可移植性、可维护 性，对彼此交流和协同开发将起到事半功倍的作用。 制定本编程规范的目的是为了提高软件开发效率及所开发软件 的可维护性，提高软件的质量。本规范由程序风格、命名规范、注释 规范、可移植性以及软件的模块化规范等部分组成。 用简单的方法去做复杂的事！ ！！ 5 / 21 1 代码编写总体原则 1.1 清晰第一 清晰性是易于维护、 易于重构的程序必须具备的特征。 代码首先 是给人读的，好的代码应该像好的文章一样发声朗读出来。 目前软件维护期成本占整个软件生命周期成本的 40%-90% 。根 据业界经验， 维护期变更代码的成本， 小型系统是开发期的 5 倍，大 型系统（ 100 万行代码以上）可以达到 100 倍。业界的调查指出，开 发组平均大约一半的人力用于弥补过去的错误， 而不是添加新的功能 来帮助公司提高竞争力。 一般情况下， 代码的可阅读性高于性能， 只 有确定性能是瓶颈时，才应该主动优化。 “程序必须为阅读它的人而编写，只是顺便用于机器执行。 ” ―― Harold Abelson 和 Gerald Jay “编写程序应该以人为本，计算机第二。 ” ――Steve McConnell 1.2 简洁为美 简洁就是易于理解并且易于实现。 代码越长越难于看懂， 也越容 易在修改时引入错误， 写的代码越多， 意味着出错的地方越多， 也就 意味着代码的可靠性越低。 因此，我们提倡大家通过编写简洁明了的 代码来提升代码可靠性。 废弃的代码 ( 没有被调用的函数和全局变量 ) 要及时清除，重复代码应该尽可