中兴c语言编程规范

中兴 c 语言编程规范篇一：C 语言编程规范和范例C 语言编程规范 版本号： 拟定人： 完成日期： 申屠浩 目录 一、 二、 三、 四、 五、 六、 排版 .3 缩进 .3 空行 .3 空格 .3 折行 .4 独占 .5 大括号 .5 注释 .6 一致性 .6 文件头 .6 函数前 .7 功能解释 .7 变量描述 .7 命名 .8 简明 .8 函数 .9 变量 .9 宏/常量/枚举量 .9 反义词组命名 .9 可读性 .10 括号标识优先级 . 10 标识符 .10 代码相邻 .11 语句 .11 公共变量、函数 . 12 公共变量 .12 函数 .13 宏 .14 宏 .14 一、 排版 缩进 ? 程序块要采用缩进风格编写，缩进的空格数为 4 个 说明：对于由开发工具自动生成的代码可以有不一致。空行 ? 函数之间加空行 ? 区块之间加空行 示例：如下例子不符合规范。 if (!valid_ni(ni) . / program code repssn_ind = ssn_dataindex.repssn_index; repssn_ni = ssn_dataindex.ni; 应如下书写 if (!valid_ni(ni) . / program code repssn_ind = ssn_dataindex.repssn_index; repssn_ni = ssn_dataindex.ni; 空格 ? 逗号、分号只在后面加空格 int a, b, c; ? 比较操作符, 赋值操作符“=” 、 “+=”，算术操作符“+” 、 “%”，逻辑操作符“ a *= 2;a = b 2; ? if、for、while、switch 等与后面的括号间应加空格，使 if 等关键字更为突出、明显 if (a = b (i . / program code for (i = 0, j = 0; (i i+, j+) . / program code ? 若函数中的参数较多，也要进行适当的划分 示例： stat_str_compare(BYTE *) 独占 ? 一行只写一条语句 示例：如下例子不符合规范。 = 0; = 0; 应如下书写 = 0; = 0; ? if、for、do、while、case、switch、default 等语句自占一行；if、for、do、while 等语 句的执行语句部分无论多少都建议加上括号 示例：如下例子不符合规范。 if (pUserCR = NULL) return; 应如下书写： if (pUserCR = NULL) return; 大括号 ? 大括号 和 应各独占一行并且位于同一列，同时与引用它们的语句左对齐 if (.) . / program code 篇二：C 语言编程规范C 语言编程规范 湖南理工学院创新基地 作者彭巍 目 录 1 程序的版式 . 3 2 3 空行 . 3 代码行 . 3 空格 . 4 长行拆分 . 4 程序的注释 . 5 命名规则 . 5 共性规则 . 5 建议的简单命名规则 .6 4 表达式和基本语句 . 7 运算符的优先级 . 7 IF 语句 .7 FOR 语句 .7 SWITCH 语句 . 8 GOTO 语句 . 8 5 函数设计 . 8 参数的规则 . 8 返回值的规则 . 9 其他建议 . 9 文件设计 .9 1 程序的版式 板式虽然不会影响程序的功能，但会影响可读性.程序的板式追求清晰、美观，是程序风格的重要构成因素。 很多人认为良好的可读性只是方便其他人，对自己写程序没什么帮助，实际很大程度上可读性是在帮助自己更方便的检查程序，消除 Bug。 空行 规则 1-1-1：程序块要采用缩进风格编写，缩进的空格数为 4 个 规则 1-1-2：每个函数定义结束之后都要加空行。 规则 1-1-3：在一个函数体内，逻辑上密切相关的语句之间不加空行，其他地方应加空行分隔。 示例： while (condition) / 空行 void Function1() statement1; / 空行 /空行 void Function2() if (condition / 空行 void Function3()else / 空行 代码行 规则 1-2-1：一行代码只做一件事情。这样的好处是容易阅读，并方便注释。 示例： 如下例子不符合规范 x = a+b; y = c+d; z = e + f; 应写为： x = a + b; y = c + d; z = e + f; 注意： 如 int width, height, depth; / 宽度高度深度 因为变量之间本身关系紧凑，所以没必要分行，因为不分行更突出了紧凑。 规则 1-2-2：if、for、while、do 等语句各自占一行,执行语句不得紧跟其他。不论语句有多少都要加 。且“”与“”应该独占一行。 示例： 如下例子不符合规范。 if (width for (initialization; condition; update) dosomething(); 应写为： if (width dosomething(); dosomething(); 空格 规则 1-3-1：关键字之后应留一个空格。 规则 1-3-2：函数名之后不留空格，紧跟“（” ，以与关键字区别。 示例： void Func1(int x, int y, int z);/ 良好的风格 void Func1 (int x,int y,int z);/ 不良的风格 规则 1-3-3：“， ”之后要留空格，如 Function (x, y, z)。如果“；”不室是一行的结束符号,其后要留空格。如：for (initialization; condition; update) 规则 1-3-4：赋值操作符、比较操作符、算术操作符、逻辑操作符、位域操作符的前后应加空格。但一元操作符如“！” 、 “”、 “+”、 “-”、 “ 2 程序的注释 C 语言的注释符有“/*.*/”与“/.” 注释通常用于： (1) 版本、版权声明； (2) 函数接口说明； (2) 重要的代码行或段落提示。 一个注释不详细的程序过一段时间后不但别人看不懂，自己肯定也会看不懂！ 规则 2-1：注释是对“代码”的提示，不宜太多也不能太少，注释语言必须准确、易懂、简洁。 规则 2-2：如果代码本来就是清除的，则不必加注释。否则多此一举，令人厌烦。 例如： i+; / i 加 1，多余的注释 规则 2-3：边写代码边写注释，修改代码同时修改注释，以保证注释与代码的一致性 规则 2-4：当代码比较长，特别是有多重嵌套时，应当在一些段落的结束处加注释，便于阅读。 规则 2-5：注释的位置应与被描述的代码相邻，可以放在代码的上方或右方，不可放在下方 注：详细例子请参考例程：F020 测温 3 命名规则 据考察，没有一种命名规则可以让所有的程序员赞同，程序设计教科书一般都不指定命名规则。但是一个团队必须制定一种令大多数项目成员满意的命名规则，否则，复用前人积累的智慧和财富会成为一件很复杂的事情，并且也阻碍的项目成员之间的互相交流。比较著名的命名规则当推 Microsoft 公司的“匈牙利”法,该命名规则的主要思想是“在变量和函数名种加入前缀以增进人们对程序的理解”.如所有字符变量均与 ch 为前缀,若是指针变量则追加前缀 p。 例如： char *i; / 指向字符指针的指针 若采用“匈牙利”命名规则，则应写成 char *chppi; 可以看出， “匈牙利”法最大的缺点是烦琐。如此烦琐的命名会让绝大多数程序员无法忍受。 本节论述的共性规则是被大多数程序员采纳的，我们应当在遵循这些共性规则的前提下，再扩充特定的规则。 共性规则 规则 3-1-1：名字取的应该要直观且可以拼读。标示符最好采用英文单词或其组合，便于记忆和阅读。程序中的英文单词一般不会太复杂，用词应当准确。 如不要把 CurrentValue 写成 NowValue 或写成 Dangqianzhi。 篇三：实用的 C 语言编程规范实用的 C 语言编程规范 目 录 简介.3 1 代码编写总体原则 . 4 清晰第一 .4 简洁为美 .4 选择合适的风格，与代码原有风格保持一致 . 4 2 文件结构 . 5 文件信息说明 .5 头文件的结构 .5 函数编写规则 .6 3 标示符的命名规则 . 8 4 文件命名规则 . 9 5 变量命名规则 . 10 6 函数命名规则 . 10 7 宏命名规则 . 10 8 变量.10 9 注释.12 10 排版与格式 . 14 11.对齐 .16 12 参数设计规则 .17 13 返回值的规则 .18 简介：在项目团队协作开发的情况下,编程时应该强调的一个重要方面是程序的易读性，在保证软件速度等性能指标能满足用户需求的情况下，能让其他程序员容易读懂你所编写的程序。若项目小组的所有开发人员都遵循统一的、鲜明的一套编程风格，可以让协作者、后继者和自己一目了然，在很短的时间内看清楚程序结构，理解设计的思路，大大提高代码的可读性、可重用性、程序健壮性、可移植性、可维护性，对彼此交流和协同开发将起到事半功倍的作用。 制定本编程规范的目的是为了提高软件开发效率及所开发软件的可维护性，提高软件的质量。本规范由程序风格、命名规范、注释规范、可移植性以及软件的模块化规范等部分组成。 用简单的方法去做复杂的事！ 1 代码编写总体原则 清晰第一 清晰性是易于维护、易于重构的程序必须具备的特征。代码首先是给人读的，好的代码应该像好的文章一样发声朗读出来。 目前软件维护期成本占整个软件生命周期成本的 40%-90%。根据业界经验，维护期变更代码的成本，小型系统是开发期的 5 倍，大型系统（100 万行代码以上）可以达到100 倍。业界的调查指出，开发组平均大约一半的人力用于弥补过去的错误，而不是添加新的功能来帮助公司提高竞争力。一般情况下，代码的可阅读性高于性能，只有确定性能是瓶颈时，才应该主动优化。 “程序必须为阅读它的人而编写，只是顺便用于机器执行。 ” Harold Abelson 和 Gerald Jay “编写程序应该以人为本，计算机第二。 ” Steve McConnell 简洁为美 简洁就是易于理解并且易于实现。代码越长越难于看懂，也越容易在修改时引入错误，写的代码越多，意味着出错的地方越多，也就意味着代码的可靠性越低。因此，我们提倡大家通过编写简洁明了的代码来提升代码可靠性。废弃的代码(没有被调用的函数和全局变量)要及时清除，重复代码应该尽可能提炼成函数。 选择合适的风格，与代码原有风格保持一致 产品所有人共同分享同一种风格所带来的好处，远远超出为了统一而付出的代价。在公司已有编码规范的指导下，审慎地编排代码以使代码尽可能清晰，是一项非常重要的技能。 2 文件结构每个 C 程序通常分为两个文件。一个文件用于保存程序的声明（declaration） ，称为头文件。另一个文件用于保存程序的实现（implementation） ，称为定义（definition）文件。C 程序的头文件以“.h”为后缀，C程序的定义文件以“.c”为后缀。 文件信息说明 文件信息声明位于头文件和