工程C编程规范.docVIP

技 术 文 件 标题: 工程C软件编程规范 编 号: 版 本: V 1. 共 页 (包括封面) 作者 尤毅 时间 审核 上海华冠电子设备有限公司 目录 文档修改历史 2 1. 概述 1 1.1. 编写目的 1 1.2. 术语和缩写 1 1.3. 参考资料 1 2. 通用代码规范 1 2.1. 编排 1 2.2. 命名 3 2.3. 变量定义 5 2.4. 语句编码规范 5 2.5. 函数 7 2.6. 注释 9 2.7. 故障检测 10 2.8. 算法 11 2.9. 编译连接 11 2.10. 源文件组织 11 3. 附录 12 3.1. 常用缩略语汇总 12 文档修改历史 2001-4-10 版本V1.21 在“2.1编排”的“{和}2001-4-11 版本V1.22 在“2.2 命名”中，增加一项原则 在“2.2 命名”中，插入H项“要准确。名字与它……” 在“2.2 命名”中，插入I项“对返回布尔类型值……” 在“2.2 命名”中，插入J项“保持命名的一致性……” 在“2.4 语句编码规范”的“F switch语句if语句2001-8-20 版本V1.23 在“2.2 命名”中，插入H项，插入E项“结构名：结构的命名……” 在“2.2 命名”C项中，增加说明“结构变量的命名，类型部分可以是结构名的缩写，或者省略。结构成员的命名，范围部分一般加“m_”的前缀。”  概述 编写目的 本规范适用于华冠电子设备有限公司开发部软件开发组采用工程C的软件设计开发。版本控制工具采用Microsoft Visual SourceSafe 6.0。 术语和缩写 参考资料 为了提高程序的可靠性、易维护性、可重用性，开发应当遵循以下原则： 简单明晰 显然，程序越简单，出错的可能性就越小。同时，也将大大提高程序的可读性。能采用简单的算法、简单的数据结构的，尽量使用简单的方法，避免为了少量的程序效率提高或使用存储空间的减少而使用复杂的方法。 可靠性 程序可靠性是指无故障使用的间隔时间。应能保证系统正确、可靠地运行，保证有关程序和数据的安全，对出现的异常应能作出相应的处理，避免系统崩溃现象发生。 可重用性 包括代码的重用性和组件的重用性。 可读性 程序员在编写程序时，应当意识到今后会有人反复阅读这个程序，并沿着自己的思路去理解程序的功能，所以应当注意程序代码的可读性。 高效性 在保证代码简单易用和可靠性的前提下，应尽量做到使程序高效。使用C编程的一个重要原因就是程序的效率较高，应避免出现低效重复的代码。 通用代码规范 一般来说，任何编程风格的目标都是清晰易懂，编码清晰化中最关键的一条就是保持一致性，无论使用什么风格，都要保证在整个项目中始终如一。为方便起见，以下条目中以斜体显示的为建议执行，而其余的为强制要求。 编排 缩进 代码的每级缩进为4个空格，由于制表符在不同的编辑器中的间隔不同，因此禁止在源代码中保存Tab制表符。 空格 各词法单位之间使用一个空格以增强程序的可读性，如a=b应写成a = b; 空行 每两段程序之间加入一空行，每两个函数之间，加入两个空行，使程序显得清洁整齐。 页边界 一般源代码每行的字符数不得超过80，除非只剩下一个单词。 换行 如一行源代码超过了80个字符，可在逗号和操作符后面开始换行，并相对第一行缩进4个空格。如果是字符串常量，使用续行符后换行。对于函数调用，若参数较多，需要换行，可在函数名后第一个参数处与上行对齐。如： GetNeededVal(int v_iSelID, int v_iCode, BYTE v_ucFlag, BSTR v_bstrMyName, BYTE * v_pucRetCode ); 对程序行的注释，如果太长，可以换行后，在上一行注释开始处对齐，如： pDataIn = ( BYTE * )pValue; /* pValue是输入的参数，为BYTE数组*/ /* 此处把指针保存在pDataIn中*/ {和} 一般来讲， { 应独占一行，如下所示： if ( x == y ) { x = x + y; } 下面这种情况例外，即在else语句之后，可以将 { 与else写在一行。 If ( x == y ) { x = x + y; } else { x = x – y; } } 则总是独占一行。 在括号内的内容多于20行的情况下，在每一对括号的第二个括号后添加括号结束标志，具体如： for(I = 1; I 100; I++) { … … … … }/