在网上找到这份单片机C51编程规范,觉得很有用,决定在今后自己编C51程序的时分用上。
1单片机C51编程规范-前语
为了进步源程序的质量和可维护性,然后终究进步软件产品生产力,特编写此规范。
2单片机C51编程规范-规划
本规范规矩了程序规划人员进行程序规划时有必要遵从的规范。本规范首要针对C51编程言语和keil编译器而言,包括排版、注释、命名、变量运用、代码可测性、程序功率、质量保证等内容。
3单片机C51编程规范-总则
l格局明晰
l注释短小精悍
l命名规范易懂
l函数模块化
l程序易读易维护
l功用精确完结
l代码空间功率和时刻功率高
l适度的可扩展性
4单片机C51编程规范-数据类型界说
编程时一致选用下述新类型名的办法界说数据类型。
树立一个datatype.h文件,在该文件中进行如下界说:
typedefbitbool;//位变量//
typedef unsigned charuint8;//无符号8位整型变量//
typedefsignedcharint8;//有符号8位整型变量//
typedef unsignedintuint16;//无符号16位整型变量//
typedef signedintint16;//有符号16位整型变量//
typedef unsigned longuint32;//无符号32位整型变量//
typedef signedlongint32;//有符号32位整型变量//
typedeffloatfp32;//单精度浮点数(32位长度) //
typedefdoublefp64;//双精度浮点数(64位长度) //
5单片机C51编程规范-标识符命名
5.1命名基本准则
l命名要明晰明晰,有清晰含义,运用完好单词或约好俗成的缩写。一般,较短的单词可经过去掉元音字母构成缩写;较长的单词可取单词的头几个字母构成缩写。即”见名知意”。
l命名风格要从头到尾坚持一致。
l命名中若运用特别约好或缩写,要有注释阐明。
l除了编译开关/头文件等特别运用,应防止运用以下划线开端和/或完毕的界说。
l同一软件产品内模块之间接口部分的标识符称号之前加上模块标识。
5.2宏和常量命名
宏和常量用悉数大写字母来命名,词与词之间用下划线分隔。对程序中用到的数字均运用有含义的枚举或宏来替代。
5.3变量命名
变量名用小写字母命名,每个词的第一个字母大写。类型前缀(u8s8 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(),不参加、出口参数等信息。
/***********************************************************
函数称号:
函数功用:
进口参数:
出口参数:
补白:
***********************************************************/
6.3.2代码注释
代码注释应与被注释的代码紧邻,放在其上方或右方,不行放在下面。如放于上方则需与其上面的代码用空行离隔。一般少数注释应该增加在被注释句子的行尾,一个函数内的多个注释左对齐;较多注释则应加在上方且注释行与被注释的句子左对齐。
函数代码注释用”//…//”的格局。
一般,分支句子(条件分支、循环句子等)有必要编写注释。其程序块完毕行”}”的右方应加标明该程序块完毕的符号”end of ……”,尤其在多重嵌套时。
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花括号
l if、else if、else、for、while句子不管其履行体是一条句子仍是多条句子都有必要加花括号,且左右花括号各独占一行。
l do{}while()结构中,”do”和”{“均各占一行,”}”和”while();”一起占用一行。
if ( ) do
{ {
} }while( );
else
{
}
8.6 switch句子
l每个case和其判据条件独占一行。
l每个case程序块需用break完毕。特别状况下需求从一个case块次序履行到下一个case块的时分在外,但需求在交界处清晰注释如此操作的原因,以防止犯错。
l case程序块之间空一行,且只空一行。
l每个case程序块的履行句子坚持4个空格的缩进。
l一般状况下都应该包括default分支。
Switch ( )
{
case x:
break;
case x:
break;
default:
break;
}
9单片机C51编程规范-程序结构
9.1基本要求
l有main()函数的.c文件应将main()放在最前面,并清晰用void声明参数和回来值。
l对由多个.c文件组成的模块程序或完好监控程序,树立公共引证头文件,将需求引证的库头文件、规范寄存器界说头文件、自界说的头文件、大局变量等均包括在内,供每个文件引证。一般,规范函数库头文件选用尖角号< >标志文件名,自界说头文件选用双撇号″″标志文件名。
l每个.c文件有一个对应的.h文件,.c文件的注释之后首要界说一个仅有的文件标志宏,并在对应的.h文件中解析该标志。
在.c文件中:
#define FILE_FLAG
在.h文件中:
#ifdef FILE_FLAG
#define XXX
#else
#define XXX extern
#endif
l关于确认只被某个.c文件调用的界说能够独自列在一个头文件中、独自调用。
9.2可重入函数
可重入函数中若运用了大局变量,应经过关中止、信号量等操作手法对其加以维护。
9.3函数的形参
l由函数调用者担任查看形参的合法性。
l尽量防止将形参作为作业变量运用。
9.4循环
l尽量削减循环嵌套层数
l在多重循环中,应将最忙的循环放在最内层
l循环体内作业量最小
l尽量防止循环体内含有判别句子