C语言编码规范教材_修改@wangjs.pptVIP

CC++编码规范 SI-TECH 目 录 概述 文件体系结构 排版规则 注释规则 变量和结构 函数和过程 可测性要求 程序效率 质量保证 安全规则 概述 规范本身应该是个规定，但C/C++在编码上并没有这样的规定，凡符合C/C++语法的就是合格的代码，但符合C/C++语法的代码不一定是优秀的代码，要对一些不良行为做约定。 代码本身也可能会进行合作研发或后期维护，那么一个表达统一、结构清楚的代码是必要的。 由这两点产生了编码规范，所以编码规范就是公司或团体对代码编写的一个规定和约定 目 录 概述 文件体系结构 排版规则 注释规则 变量和结构 函数和过程 可测性要求 程序效率 质量保证 安全规则 文件体系结构 / 文件路径 建议文件路径存放方式 ——bin　　 执行文件 ——log　 　日志文件 ——lib　　 库文件 ——include　头文件 ——dat　　 数据文件 ——cfg　　 配置文件 ——src　　 源程序（编译环境） ——shell　 脚本文件（生产环境） 文件体系结构 / 文件结构 c、pc、cpp文件都在文件头加入文件注释。 H头文件结构如下： 文件体系结构 / 文件命名 源文件按照用途等分类，一般如下： Xxmain.c Xxpublic.c Xxstd.h Xxmain.h Xxdata.c 根据程序的原始意义，加入main、std、public、业务名等相关信息。 工程中不起作用的文件或类应删除，工程目录下的非工程文件也应该移走，保持工程的清洁，避免混淆难于管理。 目 录 概述 文件体系结构 排版规则 注释规则 变量和结构 函数和过程 可测性要求 程序效率 质量保证 安全规则 排版规则 / 空行和缩进 在每个类声明之后、每个函数定义结束之后都要加空行 在一个函数体内，逻揖上密切相关的语句之间不加空行，其它地方应加空行分隔 程序排版使用缩进时，使用TAB键，显示时TAB键定义为4个空格长 排版规则 / 逻辑表达式 (1) 常量和变量做等于比较时，要求常量在前，变量在后 在做联合比较时，合理使用空格 排版规则 / 逻辑表达式(2) 不可将布尔变量直接与TRUE、FALSE或者1、0进行比较 将整型变量用“==”或“！=”直接与0比较 将指针变量用“==”或“！=”与NULL比较 排版规则 / 逻辑表达式(3) 不可将浮点变量用“==”或“！=”与任何数字比较 千万要留意，无论是float还是double类型的变量，都有精度限制。所以一定要避免将浮点变量用“==”或“！=”与数字比较，应该设法转化成“=”或“=”形式 代码行不要过长，最大长度宜控制在70至80个字符以内，长表达式要拆分成新行，拆分出的新行要进行缩进 排版规则 / 操作符 一元操作符 如“!”、“~”、“++”、“--”、“”（地址运算符）等前后不加空格 象“［］”、“.”、“-”这类操作符前后不加空格 二元操作符 赋值操作符、比较操作符、算术操作符、逻辑操作符、位域操作符，如“=”、“+=” “=”、“=”、“+”、“*”、“%”、“”、“||”、“”,“^”等二元操作符的前后应当加空格 目 录 概述 文件体系结构 排版规则 注释规则 变量和结构 函数和过程 可测性要求 程序效率 质量保证 安全规则 注释规则 注释方法 C语言的注释符为“/*…*/”。 C++语言中，程序块的注释常采用“/*…*/”，行注释一般采用“//…”。 考虑到兼容性，建议一律使用/*...*/。 修改代码中要加入修改内容、修改人、修改时间 修改代码同时修改相应的注释，以保证注释与代码的一致性。不再有用的注释要删除。 注释规则 / 使用Doxygen Doxygen 是一个优秀的文档生成工具，支持C、JAVA等语言，借助此工具，可以自动生成图文并茂的代码说明文档 注释规则 / 文件开头 列出版权说明、版本号、生成日期、作者、功能、和其他文件的关系、修改日志等 注释规则 / 函数 列出函数的目的/功能、输入参数、输出参数、返回值、调用关系（函数、表）等 注释规则 / 程序块 程序块的注释采用“/*…*/”；当代码比较长，特别是有多重嵌套时，应当在一些段落的结束处加注释 对于所有有物理含义的变量、常量，如果其命名不是充分自注释的，在声明时都必须加以注释，说明其物理含义 目 录 概述 文件体系结构 排版规则 注释规则 变量和结构 函数和过程 可测性要求 程序效率 质量保证 安全规则 变量和结构 / 变量命名规则 变量的命名方案：“1位小写的作用域标识＋1位小写的类型标识＋开头为大写的变