单片机C51编程规范.docx
- 文档编号:29683929
- 上传时间:2023-07-26
- 格式:DOCX
- 页数:17
- 大小:24.85KB
单片机C51编程规范.docx
《单片机C51编程规范.docx》由会员分享,可在线阅读,更多相关《单片机C51编程规范.docx(17页珍藏版)》请在冰豆网上搜索。
单片机C51编程规范
1单片机C51编程规范-前言
为了提高源程序的质量和可维护性,从而最终提高软件产品生产力,特编写此规范。
2单片机C51编程规范-范围
本标准规定了程序设计人员进行程序设计时必须遵循的规范。
本规范主要针对C51编程语言和keil编译器而言,包括排版、注释、命名、变量使用、代码可测性、程序效率、质量保证等内容。
3单片机C51编程规范-总则
l格式清晰
l注释简明扼要
l命名规范易懂
l函数模块化
l程序易读易维护
l功能准确实现
l代码空间效率和时间效率高
l适度的可扩展性
4单片机C51编程规范-数据类型定义
编程时统一采用下述新类型名的方式定义数据类型。
建立一个datatype.h文件,在该文件中进行如下定义:
typedefbitBOOL;//位变量//
typedefunsignedcharINT8U;//无符号8位整型变量//
typedefsignedcharINT8S;//有符号8位整型变量//
typedefunsignedintINT16U;//无符号16位整型变量//
typedefsignedintINT16S;//有符号16位整型变量//
typedefunsignedlongINT32U;//无符号32位整型变量//
typedefsignedlongINT32S;//有符号32位整型变量//
typedeffloatFP32;//单精度浮点数(32位长度)//
typedefdoubleFP64;//双精度浮点数(64位长度)//
5单片机C51编程规范-标识符命名
5.1命名基本原则
l命名要清晰明了,有明确含义,使用完整单词或约定俗成的缩写。
通常,较短的单词可通过去掉元音字母形成缩写;较长的单词可取单词的头几个字母形成缩写。
即"见名知意"。
l命名风格要自始至终保持一致。
l命名中若使用特殊约定或缩写,要有注释说明。
l除了编译开关/头文件等特殊应用,应避免使用以下划线开始和/或结尾的定义。
l同一软件产品内模块之间接口部分的标识符名称之前加上模块标识。
5.2宏和常量命名
宏和常量用全部大写字母来命名,词与词之间用下划线分隔。
对程序中用到的数字均应用有意义的枚举或宏来代替。
5.3变量命名
变量名用小写字母命名,每个词的第一个字母大写。
类型前缀(u8\s8etc.)全局变量另加前缀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(),不加入、出口参数等信息。
/***********************************************************
函数名称:
函数功能:
入口参数:
出口参数:
备注:
***********************************************************/
6.3.2代码注释
代码注释应与被注释的代码紧邻,放在其上方或右方,不可放在下面。
如放于上方则需与其上面的代码用空行隔开。
一般少量注释应该添加在被注释语句的行尾,一个函数内的多个注释左对齐;较多注释则应加在上方且注释行与被注释的语句左对齐。
函数代码注释用"//…//"的格式。
通常,分支语句(条件分支、循环语句等)必须编写注释。
其程序块结束行"}"的右方应加表明该程序块结束的标记"endof……",尤其在多重嵌套时。
6.4变量、常量、宏的注释
同一类型的标识符应集中定义,并在定义之前一行对其共性加以统一注释。
对单个标识符的注释加在定义语句的行尾。
全局变量一定要有详细的注释,包括其功能、取值范围、哪些函数或过程存取它以及存取时的注意事项等。
注释用"//…//"的格式。
7单片机C51编程规范-函数
7.1设计原则
函数的基本要求:
l正确性:
程序要实现设计要求的功能。
l稳定性和安全性:
程序运行稳定、可靠、安全。
l可测试性:
程序便于测试和评价。
l规范/可读性:
程序书写风格、命名规则等符合规范。
l扩展性:
代码为下一次升级扩展留有空间和接口。
l全局效率:
软件系统的整体效率高。
l局部效率:
某个模块/子模块/函数的本身效率高。
编制函数的基本原则:
l单个函数的规模尽量限制在200行以内(不包括注释和空行)。
一个函数只完成一个功能。
l函数局部变量的数目一般不超过5~10个。
l函数内部局部变量定义区和功能实现区(包含变量初始化)之间空一行。
l函数名应准确描述函数的功能。
通常使用动宾词组为执行某操作的函数命名。
l函数的返回值要清楚明了,尤其是出错返回值的意义要准确无误。
l不要把与函数返回值类型不同的变量,以编译系统默认的转换方式或强制的转换方式作为返回值返回。
l减少函数本身或函数间的递归调用。
l尽量不要将函数的参数作为工作变量。
7.2函数定义
l函数若没有入口参数或者出口参数,应用void明确申明。
l函数名称与出口参数类型定义间应该空一格且只空一格。
l函数名称与括号()之间无空格。
l函数形参必须给出明确的类型定义。
l多个形参的函数,后一个形参与前一个形参的逗号分割符之间添加一个空格。
l函数体的前后花括号"{}"各独占一行。
7.3局部变量定义
l同一行内不要定义过多变量。
l同一类的变量在同一行内定义,或者在相邻行定义。
l先定义data型变量,再定义idtata型变量,再定义xdata型变量.
l数组、指针等复杂类型的定义放在定义区的最后。
l变量定义区不做较复杂的变量赋值。
7.4功能实现区规范
l一行只写一条语句。
l注意运算符的优先级,并用括号明确表达式的操作顺序,避免使用默认优先级。
l各程序段之间使用一个空行分隔,加以必要的注释。
程序段指能完一个较具体的功能的一行或多行代码。
程序段内的各行代码之间相互依赖性较强。
l不要使用难懂的技巧性很高的语句。
l源程序中关系较为紧密的代码应尽可能相邻。
l完成简单功能、关系非常密切的一条或几条语句可编写为函数或定义为宏。
8单片机C51编程规范-排版
8.1缩进
代码的每一级均往右缩进4个空格的位置。
8.2分行
过长的语句(超过80个字符)要分成多行书写;长表达式要在低优先级操作符处划分新行,操作符放在新行之首,划分出的新行要进适当的缩进,使排版整齐,语句可读。
避免把注释插入分行中。
8.3空行
l文件注释区、头文件引用区、函数间应该有且只有一行空行。
l相邻函数之间应该有且只有一行空行。
l函数体内相对独立的程序块之间可以用一行空行或注释来分隔。
l函数注释和对应的函数体之间不应该有空行。
l文件末尾有且只有一行空行。
8.4空格
l函数语句尾部或者注释之后不能有空格。
l括号内侧(即左括号后面和右括号前面)不加空格,多重括号间不加空格。
l函数形参之间应该有且只有一个空格(形参逗号后面加空格)。
l同一行中定义的多个变量间应该有且只有一个空格(变量逗号后面加空格)。
l表达式中,若有多个操作符连写的情况,应使用空格对它们分隔:
在两个以上的关键字、变量、常量进行对等操作时,它们之间的操作符前后均加一个空格;在两个以上的关键字、变量、常量进行非对等操作时,其前后均不应加空格;
逗号只在后面加空格;
双目操作符,如比较操作符,赋值操作符"="、"+=",算术操作符"+"、"%",逻辑操作符"&&"、"&",位操作符"<<"、"^"等,前后均加一个空格;
单目操作符,如"!
"、"~"、"++"、"-"、"&"(地址运算符)等,前后不加空格;
"->"、"."前后不加空格;
if、for、while、switch等关键字与后面的括号间加一个空格;
8.5花括号
lif、elseif、else、for、while语句无论其执行体是一条语句还是多条语句都必须加花括号,且左右花括号各独占一行。
ldo{}while()结构中,"do"和"{"均各占一行,"}"和"while();"共同占用一行。
if()do
{{
}}while();
else
{
}
8.6switch语句
l每个case和其判据条件独占一行。
l每个case程序块需用break结束。
特殊情况下需要从一个case块顺序执行到下一个case块的时候除外,但需要在交界处明确注释如此操作的原因,以防止出错。
lcase程序块之间空一行,且只空一行。
l每个case程序块的执行语句保持4个空格的缩进。
l一般情况下都应该包含default分支。
Switch()
{
casex:
break;
casex:
break;
default:
break;
}
9单片机C51编程规范-程序结构
9.1基本要求
l有main()函数的.c文件应将main()放在最前面,并明确用void声明参数和返回值。
l对由多个.c文件组成的模块程序或完整监控程序,建立公共引用头文件,将需要引用的库头文件、标准寄存器定义头文件、自定义的头文件、全局变量等均包含在内,供每个文件引用。
通常,标准函数库头文件采用尖角号<>标志文件名,自定义头文件采用双撇号″″标志文件名。
l每个.c文件有一个对应的.h文件,.c文件的注释之后首先定义一个唯一的文件标志宏,并在对应的.h文件中解析该标志。
在.c文件中:
#defineFILE_FLAG
在.h文件中:
#ifdefFILE_FLAG
#defineXXX
#else
#defineXXXextern
#endif
l对于确定只被某个.c文件调用的定义可以单独列在一个头文件中、单独调用。
9.2可重入函数
可重入函数中若使用了全局变量,应通过关中断、信号量等操作手段对其加以保护。
9.3函数的形参
l由函数调用者负责检查形参的合法性。
l尽量避免将形参作为工作变量使用。
9.4循环
l尽量减少循环嵌套层数
l在多重循环中,应将最忙的循环放在最内层
l循环体内工作量最小
l尽量避免循环体内含有判断语句
软件设计更多地是一种工程,而不是一种个人艺术。
如果不统一编程规范,最终写出的程序,其可读性将较差,这不仅给代码的理解带来障碍,增加维护阶段的工作量,同时不规范的代码隐含错误的可能性也比较大。
分析表明,编码阶段产生的错误当中,语法错误大概占20%左右,而由于未严格检查软件逻辑导致的错误、函数(模块)之间接口错误及由于代码可理解度低导致优化维护阶段对代码的错误修改引起的错误则占了一半以上。
可见,提高软件质量必须降低编码阶段的错误率。
如何有效降低编码阶段的错误呢?
这需要制定详细的软件编程规范,并培训每一位程序员,最终的结果可以把编码阶段的错误降至10%左右,同时也降低了程序的测试费用,效果相当显著。
本文从代码的可维护性(可读性、可理解性、可修改性)、代码逻辑与效率、函数(模块)接口、可测试性四个方面阐述了软件编程规范,规范分成规则和建议两种,其中规则部分为强制执行项目,而建议部分则不作强制,可根据习惯取舍。
1.排版
规则1
程序块使用缩进方式,函数和标号使用空格缩进,程序段混合使用TAB和空格缩进。
缩进的目的是使程序结构清晰,便于阅读和理解。
例如:
MOVR1,#00H
MOVR2,#00H
MOVPMR,#PMRNORMAL
MOVDPS,#FLAGDPTR
MOVDPTR,#ADDREEPROM
read1kloop:
read1kpage:
INCR1
MOVXA,@DPTR
MOVSBUF,A
JNBTI,$
CLRTI
INCDPTR
CJNER1,#20H,read1kpage
INCR2
MOVR1,#00H
CPLWDI
CJNER2,#20H,read1kloop;ENDOFEEPROM
规则2
在指令的操作数之间的,使用空格进行间隔,采用这种松散方式编写代码的目的是使代码更加清晰。
例如:
CJNER2,#20H,read1kloop;ENDOFEEPROM
规则3
一行最多写一条语句。
规则4
变量定义时,保持对齐。
便于阅读和检查内存的使用情况。
例如:
RegLEDLOSSEQU30H;VARIABLE;TESTLED==RegLEDLOSS.0
RegLEDRAEQU31H;VARIABLE
RUNLED_FlagEQU32H;VARIABLE;256ms改变一次RUNLED状态
RUNLED_DefEQU10H;STATIC;16*32ms=500ms改变一次LED状态
2.注释
注释的原则是有助于对程序的阅读理解,注释不宜太多也不能太少,太少不利于代码理解,太多则会对阅读产生干扰,因此只在必要的地方才加注释,而且注释要准确、易懂、尽可能简洁。
注释量一般控制在30%到50%之间。
规则1
程序在必要的地方必须有注释,注释要准确、易懂、简洁。
例如如下注释意义不大:
MOVDXCE1COUNTER,#00H;将DXCE1COUNTER赋值为0
而如下的注释则给出了额外有用的信息:
JNZPcComm_Err;假如校验出错
规则2
注释应与其描述的代码相近,对代码的注释应放在其上方或右方(对单条语句的注释)相邻位置,不可放在下面,如放于上方则需与其上面的代码用空行隔开。
规则3
头文件、源文件的头部,应进行注释。
注释必须列出:
文件名、作者、目的、功能、修改日志等。
规则4
函数头部应进行注释,列出:
函数的目的、功能、输入参数、输出参数、涉及到的通用变量和寄存器、调用的其他函数和模块、修改日志等。
对一些复杂的函数,在注释中最好提供典型用法。
规则5
对重要代码段的功能、意图进行注释,提供有用的、额外的信息。
并在该代码段的结束处加一行注释表示该段代码结束。
规则6
对于所有的常量,变量,数据结构声明(包括数组、结构、类、枚举等),如果其命名不是充分自注释的,在声明时都必须加以注释,说明其含义。
规则7
维护代码时,要更新相应的注释,删除不再有用的注释。
保持代码、注释的一致性,避免产生误解。
3.命名
规则1
标识符缩写
形成缩写的几种技术:
1)去掉所有的不在词头的元音字母。
如screen写成scrn,primtive写成prmv。
2)使用每个单词的头一个或几个字母。
如ChannelActivation写成ChanActiv,ReleaseIndication写成RelInd。
3)使用变量名中每个有典型意义的单词。
如CountofFailure写成FailCnt。
4)去掉无用的单词后缀ing,ed等。
如PagingRequest写成PagReq。
5)使用标准的或惯用的缩写形式(包括协议文件中出现的缩写形式)。
如BSIC(BaseStationIdentificationCode)、MAP(MobileApplicationPart)。
关于缩写的准则:
1)缩写应该保持一致性。
如Channel不要有时缩写成Chan,有时缩写成Ch。
Length有时缩写成Len,有时缩写成len。
2)在源代码头部加入注解来说明协议相关的、非通用缩写。
3)标识符的长度不超过12个字符。
规则2
变量命名约定:
<前缀>+主体;注释
变量命名要考虑简单、直观、不易混淆。
前缀是可选项,表示变量类型,由于汇编中变量多是单字节变量,所以单字节变量可以不加前缀,对于bit和双字节型变量,使用小写的b和d作为前缀表示。
主体是必选项,可多个单词(或缩写)合在一起,每个单词首字母大写,其余部分小写。
规则3
常量的命名
常量的命名规则:
单词的字母全部大写,各单词之间用下划线隔开。
规则4
函数的命名
单词首字母为大写,其余均为小写。
函数名应以一个动词开头,即函数名应类似一个动词断语或祈使句。
例如:
Test_Protect,Check_EEPROM,Init_Para
4.可维护性
规则1
函数和过程中关系较为紧密的代码尽可能相邻。
规则2
每个函数的源程序行数原则上应该少于200行。
对于消息分流处理函数,完成的功能统一,但由于消息的种类多,可能超过200行的限制,不属于违反规定。
规则3
语句嵌套层次不得超过5层。
嵌套层次太多,增加了代码的复杂度及测试的难度,容易出错,增加代码维护的难度。
规则4
避免相同的代码段在多个地方出现。
当某段代码需在不同的地方重复使用时,应根据代码段的规模大小使用函数调用或宏调用的方式代替。
这样,对该代码段的修改就可在一处完成,增强代码的可维护性。
规则5
每个函数完成单一的功能,不设计多用途面面俱到的函数。
多功能集于一身的函数,很可能使函数的理解、测试、维护等变得困难。
使函数功能明确化,增加程序可读性,亦可方便维护、测试。
规则6
在函数的项目维护文档中,应该指出软件适用的硬件平台及版本。
建议1
使用专门的初始化函数对所有的公共变量进行初始化。
5.程序正确性、效率
规则1
严禁使用未经初始化的变量。
引用未经初始化的变量可能会产生不可预知的后果,特别是引用未经初始化的指针经常会导致系统崩溃,需特别注意。
规则2
防止内存操作越界。
说明:
内存操作越界是软件系统主要错误之一,后果往往非常严重。
规则3
注意变量的有效取值范围,防止表达式出现上溢或下溢。
规则4
防止易混淆的指令和操作数拼写错误。
规则5
避免函数中不必要语句,防止程序中的垃圾代码,预留代码应以注释的方式出现。
程序中的垃圾代码不仅占用额外的空间,而且还常常影响程序的功能与性能,很可能给程序的测试、维护等造成不必要的麻烦。
规则6
通过对系统数据结构的划分与组织的改进,以及对程序算法的优化来提高空间效率。
这种方式是解决软件空间效率的根本办法。
规则7
循环体内工作量最小化。
应仔细考虑循环体内的语句是否可以放在循环体之外,使循环体内工作量最小,从而提高程序的时间效率。
规则8
在多重循环中,应将最忙的循环放在最内层。
规则9
避免循环体内含判断语句,将与循环变量无关的判断语句移到循环体外。
目的是减少判断次数。
循环体中的判断语句是否可以移到循环体外,要视程序的具体情况而言,一般情况,与循环变量无关的判断语句可以移到循环体外,而有关的则不可以。
规则10
中断和恢复
中断程序应该尽量短,应该在中断中进行标记,在主程序中处理。
但实时性很高的程序段例外。
中断时应该保存所有涉及到的通用变量和寄存器,如A,PSW,DPTR等。
规则11
堆栈设置
堆栈对于程序非常重要,对于堆栈的设置要合理。
堆栈太小,在嵌套调用和很容易溢出,造成系统故障;堆栈太大,浪费RAM资源。
为了节约堆栈资源,中断时要求不要保存太多资源,中断嵌套和程序嵌套层数不要太多,尽量不要超过5层。
这就要求合理的划分功能模块。
规则12
看门狗
看门狗电路用于在单片机死机时自动复位。
单片机需要定时向看门狗发送脉冲,俗称”喂狗”。
喂狗不可太勤,这样看门狗没有起到作用;也不可太慢,这样容易造成单片机复位。
正确的喂狗应该在主循环中进行,最好是建立一个独立的系统监控进程。
不可以在定时中断中喂狗,应为单片机有时可能会在主循环中死掉。
6.接口
规则1
去掉没有必要的公共变量,编程时应尽量少用公共变量。
公共变量是增大模块间耦合的原因之一,故应减少没必要的公共变量以降低模块间的耦合度。
应该构造仅有一个模块或函数可以修改、创建,而其余有关模块或函数只访问的公共变量,防止多个不同模块或函数都可以修改、创建同一公共变量的现象。
规则2
当向公共变量传递数据时,要防止越界现象发生。
对公共变量赋值时,若有必要应进行合法性检查,以提高代码的可靠性、稳定性。
规则3
尽量不设计多参数函数,将不使用的参数从接口中去掉,降低接口复杂度,减少函数间接口的复杂度。
规则4
对所调用函数的返回码要仔细、全面地处理。
防止把错误传递到后面的处理流程。
如有意不检查其返回码,应明确指明。
规则5
检查接口函数所有输入参数的有效性。
规则6
检查函数的所有非参数输入,如外部数据、公共变量
- 配套讲稿:
如PPT文件的首页显示word图标,表示该PPT已包含配套word讲稿。双击word图标可打开word文档。
- 特殊限制:
部分文档作品中含有的国旗、国徽等图片,仅作为作品整体效果示例展示,禁止商用。设计者仅对作品中独创性部分享有著作权。
- 关 键 词:
- 单片机 C51 编程 规范
![提示](https://static.bdocx.com/images/bang_tan.gif)