C规范(自学).ppt

编程规范介绍（一） ——优秀程序员的必备素质 第一部分 排版 严格采用阶梯层次组织程序代码 及时折行 一行只写一条一句 if、for、do、while等语句格式规定 空行 空格 对变量的定义，尽量位于函数的开始位置 程序各部分的放置顺序 采用阶梯层次组织程序代码 { } 各占一行，与引用对齐 函数体开始、结构（枚举）声明、if、for、do、while、switch、case do-while是个特例（}后可以跟while） 使用Tab缩进 及时折行 选低优先级操作符前换行 使换行适当缩进（至少一个Tab） 一行只写一条语句（只出现一次分号） if、for、do、while、case、switch、default各占一行，且if、for、do、while后无论语句多少都要加花括号 空行 定义变量与程序块之间 相对独立的程序块之间 空格 逗号后，分号后（for循环） 比较、赋值、算术、逻辑等双目运算符前后加空格 !、++、--等单目运算符与运行表达式之间不加空格 -、.前后不加空格 if、for、while、switch等后面加空格，突出关键字 变量定义 同一行内不要定义过多变量 同一类的变量在同一行内定义，或相邻行定义 数组、指针复杂类型定义放在定义区的最后 变量定义区不做较复杂的变量赋初值 程序放置顺序 1、#include C的标准头文件 2、#include 用户自定义文件 3、#define 宏定义 4、全局变量定义 5、函数原型声明 6、main函数定义 7、用户自定义函数 第二部分 注释 注释的原则和目的 函数头部应进行注释 进行注释时的注意事项 注释的原则和目的 原则是有助于对程序的阅读理解，注释不宜太多也不能太少，注释语言必须准确、易懂、简洁 目的是解释代码的目的、功能和采用的方法，提供代码以外的信息，帮助读者理解代码，防止没有必要的重复注释信息 函数头部应进行注释 列出：函数的目的/功能、输入参数、输出参数、返回值、调用关系 /********************************** function:函数名称 description:函数功能描述 calls:被本函数调用的函数清单 called by:调用本函数的函数清单 input:输入参数，每个参数的作用、取值及关系 output:输出参数说明 return:函数返回值的说明 others:其它说明 **********************************/ 注释时注意事项 注释应与其描述的代码相近，在代码上方或右方（单条语句注释） 全局变量要有较详细的注释，包括功能、取值范围、哪些函数存取等 注释与描述内容进行同样的缩排 注释与其上面的代码用空行隔开 对变量定义和分支语句（条件、循环等）必须编写注释 注释时注意事项 对于switch结构中无break的case，在下一个case之前注明 在程序块结束行右方加注释标记，表明某程序块的结束 注释格式尽量统一，使用/*......*/ 第三部分 命名规则 三种流行的命名法则 命名的基本原则 变量名的命名规则 函数命名规范 函数参数命名规范 三种流行的命名法则 驼峰命名法（首字母小写） printEmployeePaychecks print_employee_paychecks 匈牙利命名法m_lpszStr 帕斯卡命名法（与驼峰类似，首字母大写） 命名的基本原则 标识符的命名要清晰、明了 对于变量命名，禁止取单个字符i、j等 不要使用数字或较奇怪的字符 变量名的命名规则 使用“匈牙利法则” 变量名=变量类型+变量的英文意思 函数的命名规范 尽量使用英文表达出函数完成的功能 必须使用函数原型声明 函数参数命名规范 参数名称的命名参照变量命名规范 传递大结构的参数，采用指针或引用方式传递 第四部分 可读性 避免使用默认的运算优先级 使用有意义的标识，避免直接使用数字 源程序中关系较为紧密的代码应尽可能相邻 不要使用难懂的技巧性很高的语句、复杂的表达式 练习 请同学们课后继续学习有关“编码规范”的相关内容并将其应用在日后的课程练习当中。 在“考试平台”下练习，进一步熟悉规范要求。 * * 总结本文，华为，桂电资料 s_ 静态变量 f float g_ 全局变量 by unsigned char p 指针 c char sz 0结尾字符串 l long int dw unsigned long int n short int w unsigned int i int d double b bool 开头部分 类型 开头部分 类型 *