单片机C程序编码规范

《单片机C程序编码规范》由会员上传分享，免费在线阅读，更多相关内容在教育资源-天天文库。

1、道路管理系统系统设计说明书目录1.概述42.命名规则42.1命名基本原则42.2预定义(#define)42.3宏和常量命名42.4变量命名42.5结构和类型定义（typedef）52.6枚举52.7函数命名52.8文件命名53.注释53.1注释基本原则53.2文件注释63.3函数注释63.4代码注释63.5变量、常量、宏的注释74.统一类型别名定义85.编码9Printedon2021-07-196/7道路管理系统系统设计说明书1.概述为了提高源程序的质量和可维护性，从而最终提高软件

2、产品生产力，特编写此规范。本标准规定了程序设计人员进行程序设计时必须遵循的规范。本规范主要针对单片机编程语言和08编译器而言，包括排版、注释、命名、变量使用、代码可测性、程序效率、质量保证等内容。2.命名规则2.1命名基本原则（1）命名清晰明了，有明确含义，使用完整单词或约定俗成的缩写。通常，较短的单词可通过去掉元音字母形成缩写；较长的单词可取单词的头几个字母形成缩写。即"见名知意"。（2）命名风格要自始至终保持一致。（3）命名中若使用特殊约定或缩写，要有注释说明。（4）为了代码复用，命名中应避免适用与具体项目相

3、关的前缀。（5）应使用英语命名。2.2预定义(#define)只使用大写字母，下划线和数字。例如：#defineMAX_LENGTH12.3宏和常量命名只使用大写字母，下划线和数字。宏和常量用全部大写字母来命名，词与词之间用下划线分隔。对程序中用到的数字均应用有意义的枚举或宏来代替。2.4变量命名变量命名规则：<<范围>_类型>名称。范围前最结构体的成员变量m_静态变量s_全局变量g_局部变量无前缀类型前缀指针（Pointer）p枚举（Enumeration）e结构（Structure）st布尔（Boolean）

4、b浮点（Float）f双精度（Double）dPrintedon2021-07-196/7道路管理系统系统设计说明书字符（Char）c其他数字类型,e.g.byte,(unsigned)int,(unsigned)longint,(unsigned)short,(unsigned)shortint,(unsigned)longlongn例如：//全局变量intg_nMaxCount;//函数体内局部变量MyEnumTypeeParsingMode;局部循环体控制变量优先使用i、j、k等

5、；局部长度变量优先使用len、num等；临时中间变量优先使用temp、tmp等。1.1结构和类型定义（typedef）按Camel-Style方式命名，如ThisIsAnExampleStructOrEnumOrTyedef。避免使用下划线。1.2枚举按Camel-Style方式命名，如ThisIsAnExampleStructOrEnumOrTyedef。避免使用下划线。EnumDataSetState{ValidModified=1,InvalidModified=2,AllDataLoaded=3}1.3函

6、数命名按Camel-Style方式命名，ThisIsAnExampleMethod。1.4文件命名一个文件包含一类功能或一个模块的所有函数，文件名称应清楚表明其功能或性质。每个.c文件应该有一个同名的.h文件作为头文件。2.注释2.1注释基本原则有助于对程序的阅读理解，说明程序在"做什么"，解释代码的目的、功能和采用的方法。一般情况源程序有效注释量在30％左右。注释语言必须准确、易懂、简洁。边写代码边注释，修改代码同时修改相应的注释，不再有用的注释要删除。汇编和C中都用"//"，取消";"不使用段注释"/**/"

7、（调试时可用）。Printedon2021-07-196/7道路管理系统系统设计说明书1.1文件注释文件注释必须说明文件名、项目名称、函数功能、创建人、创建日期、版本信息等相关信息。修改文件代码时，应在文件注释中记录修改日期、修改人员，并简要说明此次修改的目的。所有修改记录必须保持完整。文件注释放在文件顶端，用"/*……*/"格式包含。注释文本每行缩进4个空格；每个注释文本分项名称应对齐。/************************************************

8、***********文件名称：项目名称：平台信息：作者：版本：说明：修改记录：***********************************************************/1.2函数注释函数头部注释应包括函数名称、函数功能、入口参数、出口参数等内容。如有必要还可增加作者、创建日期、修改记录（备注）等相关项目。函数头部注释放在每个函数的顶端，用"