c编程规范v1.02.docVIP

C编程规范 第1.02版 上海华腾软件系统有限公司 二○○八年八月十三日  版本控制信息 版本 日期 拟稿和修改 说明 0.00 2003-3-16 林德良 初稿（讨论稿），译自Bell Lab《Recommended C Style and Coding Standards》,1997。 0.02 2003-3-25 林德良 根据反馈意见，修改了下列内容： 去掉了用英文书写注释的规定； Switch语句中的default case加上注释； 规定了函数参数个数的限制。 1.00 2003-4-28 林德良 按新的技术文档编排规范修改了封面和页眉。 1.01 2003-7-30 林德良 结合CVS版本管理要求，将程序文件序言中的文件名和版本号该用自动变量。 1.02 2008-8-13 陈大鹏 修改了注释和变量命名规则。 本文档中的所有内容为上海华腾软件系统有限公司的机密和专属所有。未经的明确书面许可，任何人不得。  目录 1 文件命名 1 2 源程序文件 1 3 头文件 1 4 其他文件 2 5 注释 2 6 说明（declaration） 4 7 函数说明 5 8 空格和空行 6 9 简单句 6 10 复合语句 7 11 运算符及表达式 8 12 基本命名约定 9 13 常量 10 14 条件编译 10 文件命名 文件主名以字母开头，由字母、数字、下划线组成。 采用下列文件名后缀： .c（C源程序） .h（头文件） .o（可重载目标文件） .a（静态库） .sl（动态库） 注：与特定编译器缺省后缀约定冲突的，遵循编译器的缺省后缀约定。 编辑工具make的控制文件取名Makefile（不要用makefile）。 自述文件取名README。 源程序文件 源文件段落依下列顺序： 序言 系统头文件引用（include） 用户头文件引用（include） 全局常量宏定义（define） 全局函数宏定义(define) 全局类型定义（typedef） 全局枚举类型定义（enums） 全局变量说明（extern） 全局变量说明（non-static） 全局变量说明（static） 函数（通常从最高层开始，按层次横向排列。如果定义较多的独立的公用函数，可以考虑按字母顺序排列。） 序言内容应包括版权声明、文件名、内容描述、版本历史，格式参见（文件头注释）： 段落之间用空行分隔。 文件长度尽可能在1000行之内。 每行长度尽可能不要超过79列。 头文件 用户头文件名避免使用系统头文件名。 按功能组织头文件，例如独立的子系统应单独一个头文件。 与机器相关的说明组成单独头文件。 多个源文件引用的说明放入头文件中。 头文件不要嵌套。 说明函数或外部变量的头文件应在定义该函数或变量的文件中引用。 不要在头文件中定义变量。 只引用需要的头文件。 每个头文件采用下面的形式避免被重复引用： #ifndef _EXAMPLE_H_ #define _EXAMPLE_H_ ... /* body of example.h file */ #endif /* _EXAMPLE_H_ */ 引用头文件不要使用绝对路径。使用filename.h引用系统头文件；使用“filename.h””引用用户头文件，并使用C编译器的–I选项指出路径。 与数据库中字段值相关的宏定义规则： /* tbl_opr_degree_def.opr_degree 柜员签到状态 */ #define OPR_LOG_STAT_LOGOUT 0 /*-未签到*/ #define OPR_LOG_STAT_LOGIN 1 /*-签到*/ #define OPR_LOG_STAT_TMP 2 /*-临时签退*/ #define OPR_LOG_STAT_FORBID 3 /*-强制签退*/ 其他文件 编写“README”文件，列出条件编译开关、与机器相关的文件等信息。 注释 文件头注释 每一个模块的开头都应该有一组该模块的详细的注解，以简要说明该模块作用。注释的格式如下例所示： /******************************************************************* * Copyright 2006, Shanghai Huateng Software Systems Co., Ltd. * All right reserved. * THIS IS UNPUBLISHED PROPRIETARY SOURCE CODE OF SHANGHAI HUATENG * SOFT