单片机C程序编码规范.doc

目录 1. 概述 4 2. 命名规则 4 2.1 命名基本原则 4 2.2 预定义(#define) 4 2.3 宏和常量命名 4 2.4 变量命名 4 2.5 结构和类型定义（typedef） 5 2.6 枚举 5 2.7 函数命名 5 2.8 文件命名 5 3. 注释 5 3.1 注释基本原则 5 3.2 文件注释 6 3.3 函数注释 6 3.4 代码注释 6 3.5 变量、常量、宏的注释 7 4. 统一类型别名定义 8 5. 编码 9 概述 为了提高源程序的质量和可维护性，从而最终提高软件产品生产力，特编写此规范。本标准规定了程序设计人员进行程序设计时必须遵循的规范。本规范主要针对单片机编程语言和08编译器而言，包括排版、注释、命名、变量使用、代码可测性、程序效率、质量保证等内容。 命名规则 命名基本原则 （1）命名清晰明了，有明确含义，使用完整单词或约定俗成的缩写。通常，较短的单词可通过去掉元音字母形成缩写；较长的单词可取单词的头几个字母形成缩写。即见名知意。 （2）命名风格要自始至终保持一致。 （3）命名中若使用特殊约定或缩写，要有注释说明。 （4）为了代码复用，命名中应避免适用与具体项目相关的前缀。 （5）应使用英语命名。 预定义(#define) 只使用大写字母，下划线和数字。 例如： #define MAX_LENGTH 1 宏和常量命名 只使用大写字母，下划线和数字。宏和常量用全部大写字母来命名，词与词之间用下划线分隔。对程序中用到的数字均应用有意义的枚举或宏来代替。 变量命名 变量命名规则： 范围_类型名称。 范围 前最 结构体的成员变量 m_ 静态变量 s_ 全局变量 g_ 局部变量 无前缀 类型 前缀 指针（Pointer） p 枚举（Enumeration） e 结构（Structure） st 布尔（Boolean） b 浮点（Float） f 双精度（Double） d 字符（Char） c 其他数字类型, e.g.byte, (unsigned) int, (unsigned)long int, (unsigned)short, (unsigned) short int,(unsigned) long long n 例如： //全局变量 int g_nMaxCount; //函数体内局部变量 MyEnumType eParsingMode; 局部循环体控制变量优先使用i、j、k等；局部长度变量优先使用len、num等；临时中间变量优先使用temp、tmp等。 结构和类型定义（typedef） 按Camel-Style方式命名，如ThisIsAnExampleStructOrEnumOrTyedef 。避免使用下划线。 枚举 按Camel-Style方式命名，如ThisIsAnExampleStructOrEnumOrTyedef 。避免使用下划线。 Enum DataSetState { ValidModified = 1, InvalidModified = 2, AllDataLoaded = 3 } 函数命名 按Camel-Style方式命名， ThisIsAnExampleMethod。 文件命名 一个文件包含一类功能或一个模块的所有函数，文件名称应清楚表明其功能或性质。 每个.c文件应该有一个同名的.h文件作为头文件。 注释 注释基本原则 有助于对程序的阅读理解，说明程序在做什么，解释代码的目的、功能和采用的方法。一般情况源程序有效注释量在30％左右。 注释语言必须准确、易懂、简洁。边写代码边注释，修改代码同时修改相应的注释，不再有用的注释要删除。 汇编和C中都用//，取消; 不使用段注释 /* */ （调试时可用）。 文件注释 文件注释必须说明文件名、项目名称、函数功能、创建人、创建日期、版本信息等相关信息。修改文件代码时，应在文件注释中记录修改日期、修改人员，并简要说明此次修改的目的。所有修改记录必须保持完整。 文件注释放在文件顶端，用/*……*/格式包含。 注释文本每行缩进4个空格；每个注释文本分项名称应对齐。 /*********************************************************** 文件名称： 项目名称： 平台信息： 作 者： 版 本： 说 明： 修改记录： ***********************************************************/ 函数注释 函数头部注释应包括函数名称、函数功能、入口参数、出口参数等内容。如有必要还可增加作者、创建日期、修改记录（备注）等相关项目。