coding.pptVIP

01-2-15 编程规范的说明An Introduction to CCoding Conventions 章淼 清华大学计算机系网络研究所 一流代码的特性 鲁棒 - Solid and Robust Code 简洁 - Maintainable and Simple Code 高效 - Fast Code 简短 - Small Code 共享 - Re-usable Code 可测试 - Testable Code 可移植 - Portable Code （“写好代码的10个秘诀”－微软，林斌） 编写的参考依据 “Coding Conventions” of《VxWorks Programmer’s Guide》 《Write Solid Code》（编程精粹） Manual of CVS 主要内容 文件头书写规范 代码书写规范 调试规范 基本数据结构的使用 函数的使用 代码管理方法 文件头的编写 文件头包括 文件标题（Title） 包括文件的名称和文件的简单说明。Title应该在一行内完成 版权说明（Copyright） 包括一个版权说明，长度为一行 修改记录（Modification History） 记录文件修改的过程，只记录最主要的修改。 格式为：修改时间,修改人,修改动作 文件头的编写 C代码书写规范 C Module Layout C Subroutine Layout C Declaration Formats C Code Layout C 命名规范 C Style C Header File Layout C Module Layout General Module Documentation 对整个模块目的和功能的完整描述注释 Includes：包含的头文件说明 Typedefs：类型定义 Globals：全局变量定义 只有那些可以在本模块外访问的变量才定义为全局变量 Locals：局部变量定义 使用static关键字 那些只希望在本模块内访问的变量定义为局部变量 Forward Declarations 声明将在本模块内使用，而且在本模块中实现的函数 C Module Layout 示例 C Subroutine Layout 目的：明确函数接口 包括： Banner 形式为 /********************************************** Title：由routine name和一个简单的描述组成 Description：对routine的完整描述，主要包括routine的功能和使用方法。 Returns：routine的返回值描述 如果routine的返回类型为void，则写为 RETURNS: N/A Error Number： 在ERROR标识后，列出所有可能由routine产生的错误值 C Subroutine Layout 示例 C Declaration Formats 对于基本数据类型，声明在一行内完成 C Declaration Formats 当结构定义内部使用其他结构的指针时，不使用该结构的大写名定义，而使用’struct’关键字 C Declaration Formats 函数头的写法 每个参数分行书写，后面紧跟参数的注释说明 如果函数没有输入参数，使用如下的写法： STATUS fppProbe (void) C Code Layout 缩进大小为4个字符 当使用’{‘和’}’时，使用如下的格式 C Code Layout 注释的书写 C 命名规范 C 命名规范 C Style C Style C Header File Layout 调试规范 调试开关的书写 调试开关的书写 数据类型的使用 基本数据类型 8位： int8_t uint8_t 16位： int16_t uint16_t 32位： int32_t uint32_t 64位： int64_t uint64_t 公用的数据类型 在一个项目中应当统一定义 函数的使用 Philosophy：自己尽量少编程序 尽量使用系统提供的函数 缩短开发周期；降低风险；高效 如：快排算法qsort() 尽量使用符合POSIX规范的函数接口 便于移植 Something More... 尽量少使用宏 过多的编译开关 常数的定义 代码的版本管理 如果项目有2个人以上参与，或者规模比较大，就一定要使用版本管理工具 推荐使用的版本管理工具－CVS CVS的主要操作 update commit add remove tag 冲突的解决 Where Good Codes come from? The