单片机C51编程规范
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:
- 嵌入式软件的基本测试方法(11-06)
- JCVM中栈与帧的研究和设计(06-27)
- ARM处理器的位置无关程序设计(09-19)
- IP核互连策略及规范(06-06)
- ASIC设计规范(06-06)
- Profibus网络安装规范之网络拓扑的规则(12-19)