原创 单片机编程规范(适合于单片机编程工程师)

单片机C51编程规范 

1单片机C51编程规范- 前言 
  为了提高源程序的质量和可维护性,从而最终提高软件产品生产力,特编写此规范. 

2 单片机C51编程规范-范围 
  本标准规定了程序设计人员进行程序设计时必须遵循的规范.本规范主要针对C51编程语言和keil编译器而言,包括排版、注释、命名、变量使用、代码可测性、程序效率、质量保证等内容. 

3 单片机C51编程规范-总则 
l 格式清晰 
l 注释简明扼要 
l 命名规范易懂 
l 函数模块化 
l 程序易读易维护 
l 功能准确实现 
l 代码空间效率和时间效率高 
l 适度的可扩展性 

4 单片机C51编程规范-数据类型定义 
编程时统一采用下述新类型名的方式定义数据类型. 
建立一个datatype.h文件,在该文件中进行如下定义: 
typedef bit BOOL; // 位变量 // 
typedef unsigned char INT8U; // 无符号8位整型变量 // 
typedef signed char INT8S; // 有符号8位整型变量 // 
typedef unsigned int INT16U; // 无符号16位整型变量 // 
typedef signed int INT16S; // 有符号16位整型变量 // 
typedef unsigned long INT32U; // 无符号32位整型变量 // 
typedef signed long INT32S; // 有符号32位整型变量 // 
typedef float FP32; // 单精度浮点数(32位长度) // 
typedef double FP64; // 双精度浮点数(64位长度) // 

5 单片机C51编程规范-标识符命名 

5.1 命名基本原则 
l 命名要清晰明了,有明确含义,使用完整单词或约定俗成的缩写.通常,较短的单词可通过去掉元音字母形成缩写;较长的单词可取单词的头几个字母形成缩写.即"见名知意". 
l 命名风格要自始至终保持一致. 
l 命名中若使用特殊约定或缩写,要有注释说明. 
l 除了编译开关/头文件等特殊应用,应避免使用以下划线开始和/或结尾的定义. 
l 同一软件产品内模块之间接口部分的标识符名称之前加上模块标识. 

5.2 宏和常量命名 
宏和常量用全部大写字母来命名,词与词之间用下划线分隔.对程序中用到的数字均应用有意义的枚举或宏来代替. 

5.3 变量命名 
变量名用小写字母命名,每个词的第一个字母大写.类型前缀(u8\s8 etc.)全局变量另加前缀g_. 
局部变量应简明扼要.局部循环体控制变量优先使用i、j、k等;局部长度变量优先使用len、num等;临时中间变量优先使用temp、tmp等. 

5.4 函数命名 
函数名用小写字母命名,每个词的第一个字母大写,并将模块标识加在最前面. 

5.5 文件命名 
一个文件包含一类功能或一个模块的所有函数,文件名称应清楚表明其功能或性质. 
每个.c文件应该有一个同名的.h文件作为头文件. 

6 单片机C51编程规范-注释 

6.1 注释基本原则 
l 有助于对程序的阅读理解,说明程序在"做什么",解释代码的目的、功能和采用的方法. 
l 一般情况源程序有效注释量在30%左右. 
l 注释语言必须准确、易懂、简洁. 
l 边写代码边注释,修改代码同时修改相应的注释,不再有用的注释要删除. 

6.2 文件注释 
文件注释必须说明文件名、函数功能、创建人、创建日期、版本信息等相关信息. 
修改文件代码时,应在文件注释中记录修改日期、修改人员,并简要说明此次修改的目的.所有修改记录必须保持完整. 
文件注释放在文件顶端,用"/*……*/"格式包含. 
注释文本每行缩进4个空格;每个注释文本分项名称应对齐. 
/*********************************************************** 
文件名称: 
作 者: 
版 本: 
说 明: 
修改记录: 
***********************************************************/ 

6.3 函数注释 
6.3.1 函数头部注释 
函数头部注释应包括函数名称、函数功能、入口参数、出口参数等内容.如有必要还可增加作者、创建日期、修改记录(备注)等相关项目. 
函数头部注释放在每个函数的顶端,用"/*……*/"的格式包含.其中函数名称应简写为FunctionName(),不加入、出口参数等信息. 
/*********************************************************** 
函数名称: 
函数功能: 
入口参数: 
出口参数: 
备 注: 
***********************************************************/