实用的C语言编程规范
实用的C语言编程规范
简介 5
1代码编写总体原则 6
6
6
,与代码原有风格 保持一致 6
2文件结构 7
7
7
8
3标示符的命名规则 10
4文件命名规则 11
5变量命名规则 12
6函数命名规则 12
7宏命名规则 12
8变量 3
9注释
10排版与格式 16
11对齐
12参数设计规则 19
20
13返回值的规则
简介:
在项目团队协作开发的情况下,编程时应该强调的一个重要方面 是程序的易读性,在保证软件速度等性能指标能满足用户需求的情况 下,能让其他程序员容易读懂你所编写的程序。 若项目小组的所有开 发人员都遵循统一的、鲜明的一套编程风格,可以让协作者、后继者 和自己一目了然,在很短的时间内看清楚程序结构,理解设计的思路, 大大提高代码的可读性、可重用性、程序健壮性、可移植性、可维护 性,对彼此交流和协同开发将起到事半功倍的作用。
制定本编程规范的目的是为了提高软件开发效率及所开发软件 的可维护性,提高软件的质量。本规范由程序风格、命名规范、注释 规范、可移植性以及软件的模块化规范等部分组成。
用简单的方法去做复杂的事! ! !
1代码编写总体原则
清晰性是易于维护、易于重构的程序必须具备的特征。代码首先 是给人读的,好的代码应该像好的文章一样发声朗读出来。
目前软件维护期成本占整个软件生命周期成本的 40%-90%。根
据业界经验,维护期变更代码的成本,小型系统是开发期的5倍,大 型系统(100万行代码以上)可以达到100倍。业界的调查指出,开 发组平均大约一半的人力用于弥补过去的错误, 而不是添加新的功能
来帮助公司提高竞争力。一般情况下,代码的可阅读性高于性能,只 有确定性能是瓶颈时,才应该主动优化。
“程序必须为阅读它的人而编写,只是顺便用于机器执行。”
Harold Abelson 和 Gerald Jay
编写程序应该以人为本,计算机第二。 ”
Steve McCo nn ell
简洁就是易于理解并且易于实现。代码越长越难于看懂,也越容 易在修改时引入错误,写的代码越多,意味着出错的地方越多,也就 意味着代码的可靠性越低。因此,我们提倡大家通过编写简洁明了的 代码来提升代码可靠性。废弃的代码(没有被调用的函数和全局变量) 要及时清除,重复代码应该尽可能提炼成函数。
,与代码原有风格保持一致
产品所有人共同分享同一种风格所带来的好处, 远远超出为了统 一而付出的代价。在公司已有编码规范的指导下,审慎地编排代码以 使代码尽可能清晰,是一项非常重要的技能。
2文件结构
每个C程序通常分为两个文件。一个文件用于保存程序的声明 declaration),称为头文件。另一个文件用于保存程序的实现
(implementation ),称为定义(definition )文件。C程序的头文件 以“.h”为后缀,C程序的定义文件以“ .c”为后缀。
文件信息声明位于头文件和定义文件的开头(参见示例 1),主
要内容有:
公司名称;
文件名称;
版权信息;
当前版本,作者/修改者,完成日期;
主要函数描述;
注意事项;
获班芈衣塞怒幸腕处"凉屈 可#.祝 戌山酒敷”截司 必工飯廣拓惑釐康诵"烂呑 ***-^ *■****>** ////////////
杭州航獗科技有喂公司
上Ep leJ
归蔬建杭寧殺鼓有緞公鮎有
VI .0
汪妙
斡XX
二皿应用麺較接口
A w 11- y y)r w st w » * r # jt r * W * wiffxirFsrW#
w
11
12
13
九 easy, acm
示例1
头文件由三部分内容组成:
头文件开头处的文件信息说明(参见示例1);
预处理块;
⑶函数和类结构声明等。
,应当用 ifndef/define/endif
结构产生预处理块;单词间以下划线“ 连接,例如有头文件名称
为 “ ”,则定义如下:“ #ifndef _FILE_SYSTEM_H_ ”。
#inelude < >格式来引用标准库的头文件
(编译器将从标准库目录开始搜索)。
#include “
实用的C语言编程规范 来自淘豆网m.daumloan.com转载请标明出处.