欢迎来到天天文库
浏览记录
ID:28534776
大小:76.04 KB
页数:6页
时间:2018-12-10
《单片机c51编程规范》由会员上传分享,免费在线阅读,更多相关内容在应用文档-天天文库。
1、单片机C51编程规范1单片机C51编程规范-前言 为了提高源程序的质量和可维护性,从而最终提高软件产品生产力,特编写此规范。2单片机C51编程规范-范围 本标准规定了程序设计人员进行程序设计时必须遵循的规范。本规范主要针对C51编程语言和keil编译器而言,包括排版、注释、命名、变量使用、代码可测性、程序效率、质量保证等内容。3单片机C51编程规范-总则l格式清晰l注释简明扼要l命名规范易懂l函数模块化l程序易读易维护l功能准确实现l代码空间效率和时间效率高l适度的可扩展性4单片机C51编程规范-数据
2、类型定义编程时统一采用下述新类型名的方式定义数据类型。建立一个datatype.h文件,在该文件中进行如下定义:typedefbitBOOL;//位变量//typedefunsignedcharINT8U;//无符号8位整型变量//typedefsignedcharINT8S;//有符号8位整型变量//typedefunsignedintINT16U;//无符号16位整型变量//typedefsignedintINT16S;//有符号16位整型变量//typedefunsignedlongINT32U;/
3、/无符号32位整型变量//typedefsignedlongINT32S;//有符号32位整型变量//typedeffloatFP32;//单精度浮点数(32位长度)//typedefdoubleFP64;//双精度浮点数(64位长度)//5单片机C51编程规范-标识符命名5.1命名基本原则l命名要清晰明了,有明确含义,使用完整单词或约定俗成的缩写。通常,较短的单词可通过去掉元音字母形成缩写;较长的单词可取单词的头几个字母形成缩写。即"见名知意"。l命名风格要自始至终保持一致。l命名中若使用特殊约定或缩写
4、,要有注释说明。l除了编译开关/头文件等特殊应用,应避免使用以下划线开始和/或结尾的定义。l同一软件产品内模块之间接口部分的标识符名称之前加上模块标识。5.2宏和常量命名宏和常量用全部大写字母来命名,词与词之间用下划线分隔。对程序中用到的数字均应用有意义的枚举或宏来代替。5.3变量命名变量名用小写字母命名,每个词的第一个字母大写。类型前缀(u8s8etc.)全局变量另加前缀g_。局部变量应简明扼要。局部循环体控制变量优先使用i、j、k等;局部长度变量优先使用len、num等;临时中间变量优先使用temp
5、、tmp等。5.4函数命名函数名用小写字母命名,每个词的第一个字母大写,并将模块标识加在最前面。5.5文件命名一个文件包含一类功能或一个模块的所有函数,文件名称应清楚表明其功能或性质。每个.c文件应该有一个同名的.h文件作为头文件。6单片机C51编程规范-注释6.1注释基本原则l有助于对程序的阅读理解,说明程序在"做什么",解释代码的目的、功能和采用的方法。l一般情况源程序有效注释量在30%左右。l注释语言必须准确、易懂、简洁。l边写代码边注释,修改代码同时修改相应的注释,不再有用的注释要删除。6.2文件
6、注释文件注释必须说明文件名、函数功能、创建人、创建日期、版本信息等相关信息。修改文件代码时,应在文件注释中记录修改日期、修改人员,并简要说明此次修改的目的。所有修改记录必须保持完整。文件注释放在文件顶端,用"/*……*/"格式包含。注释文本每行缩进4个空格;每个注释文本分项名称应对齐。/***********************************************************文件名称:作者:版本:说明:修改记录:*********************************
7、**************************/6.3函数注释6.3.1函数头部注释函数头部注释应包括函数名称、函数功能、入口参数、出口参数等内容。如有必要还可增加作者、创建日期、修改记录(备注)等相关项目。函数头部注释放在每个函数的顶端,用"/*……*/"的格式包含。其中函数名称应简写为FunctionName(),不加入、出口参数等信息。/***********************************************************函数名称:函数功能:入口参数:出口参数:
8、备注:***********************************************************/6.3.2代码注释代码注释应与被注释的代码紧邻,放在其上方或右方,不可放在下面。如放于上方则需与其上面的代码用空行隔开。一般少量注释应该添加在被注释语句的行尾,一个函数内的多个注释左对齐;较多注释则应加在上方且注释行与被注释的语句左对齐。函数代码注释用"//…//"的格式。通常,分支语句(条件分支、循环
此文档下载收益归作者所有