单片机程序设计编程规范

合集下载

C51编程规范--很好的规范

C51编程规范--很好的规范

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

2 单片机C51编程规范-范围本标准规定了程序设计人员进行程序设计时必须遵循的规范。

本规范主要针对C51编程语言和kei§编译器而言,包括排版、注释、命名、变量使用、代码可测性、程序效率、质量保证等内容。

3 单片机C51编程规范-总则格式清晰注释简明扼要命名规范易懂函数模块化程序易读易维护功能准确实现代码空间效率和时间效率高适度的可扩展性4 单片机C51编程规范-数据类型定义编程时统一采用下述新类型名的方式定义数据类型。

建立一个datatype.h文件,在该文件中进行如下定义:typedef bit BOO§; // 位变量//typedef unsigned char INT8U; // 无符号8位整型变量//typedef signed char INT8S; // 有符号8位整型变量//typedef unsigned int INT16U; // 无符号16位整型变量//typedef signed int INT16S; // 有符号16位整型变量//typedef unsigned §ong INT32U; // 无符号32位整型变量//typedef signed §ong INT32S; // 有符号32位整型变量//typedef f§oat FP32; // 单精度浮点数(32位长度) //typedef doub§e FP64; // 双精度浮点数(64位长度) //5 单片机C51编程规范-标识符命名5.1 命名基本原则§命名要清晰明了,有明确含义,使用完整单词或约定俗成的缩写。

通常,较短的单词可通过去掉元音字母形成缩写;较长的单词可取单词的头几个字母形成缩写。

即"见名知意"。

单片机编程方法

单片机编程方法

单片机编程方法
单片机(MCU)编程涉及到使用特定的编程语言(如C或汇编)来编写指令,这些指令告诉单片机如何执行特定的任务。

以下是一些单片机编程的基本步骤和注意事项:
1. 选择编程语言:大多数单片机编程使用C语言,因为它易于理解且效率高。

汇编语言也可以使用,但更复杂。

2. 选择开发环境:你需要一个集成开发环境(IDE),如Keil、IAR Embedded Workbench 或 Visual Studio等,这些IDE可以编译你的代码并上传到单片机。

3. 了解单片机的架构和特性:每种单片机都有其自己的指令集、特性和外设。

你需要阅读单片机的数据手册和技术规范,以了解如何编程和使用其外设。

4. 编写代码:根据你的需求,开始编写代码。

这可能涉及到配置单片机的各种外设(如GPIO、UART、SPI、PWM等),以及编写主程序。

5. 编译代码:使用IDE编译你的代码。

如果代码有错误,IDE会提示你。

6. 调试代码:编译成功后,将程序下载到单片机中进行调试。

使用调试器查看程序的运行状态,找出并修正任何错误。

7. 优化代码:根据需要优化代码,以提高其执行效率或减小其占用的存储空间。

8. 测试和部署:在确认代码工作正常后,进行更广泛的测试,然后将其部署到实际应用中。

以上就是单片机编程的基本步骤。

需要注意的是,单片机编程需要对硬件和软件都有深入的理解,因此可能需要一定的学习和实践才能掌握。

单片机程序设计编程规范

单片机程序设计编程规范

单片机程序设计编程规范1. 概述本文将介绍单片机程序设计编程过程中应遵循的一些规范。

这些规范旨在提高程序的可读性、可维护性和可重用性,帮助开发人员编写出高质量的单片机程序。

2. 代码布局2.1 源文件结构每个源文件应包含程序的一个完整模块。

源文件以 `.c` 扩展名结尾。

源文件应包含适当的注释,以说明文件的目的和模块。

2.2 函数布局每个函数应尽可能短小,只完成一项具体的功能。

函数应使用有意义的名称,具有描述性。

函数应尽量避免超过 30 行的代码,如果超过应考虑是否需要进行函数分割。

3. 变量命名规范3.1 命名风格变量名应使用小写字母和下划线的组合,如 `my_variable`。

常量应使用全大写字母和下划线的组合,如 `MY_CONSTANT`。

3.2 变量名长度变量名应该具有描述性,尽量避免使用过于简单或过于复杂的变量名。

变量名长度应控制在 20 个字符以内,以保证可读性。

4. 注释规范4.1 文件注释每个源文件应包含文件注释,用于说明文件的目的和模块。

4.2 函数注释每个函数应包含函数注释,用于说明函数的功能、参数和返回值。

4.3 行内注释行内注释应用于解释代码的特定部分,帮助阅读者理解代码的意图。

5. 常量定义规范常量定义应尽量避免使用魔术数,应该使用有意义的常量名来代替。

6. 编码风格使用正确的缩进和对齐方式,以提高代码的可读性。

使用适当的空格来增强代码的可读性,但避免过多的空格导致代码冗长。

使用适当的命名风格和约定,以提高代码的可读性。

7. 错误处理每个函数应该有清晰的错误处理机制,包括返回值、错误码和异常处理等。

错误消息应清晰、明确,并有助于定位错误。

8. 代码复用尽量避免重复的代码,使用函数和模块的方式来实现代码复用。

开发人员应鼓励制定和使用通用的接口、库和模块,以提高代码复用性。

9. 版本管理定期对代码进行版本管理,并使用版本控制工具来管理代码的修改和更新。

10.本文介绍了单片机程序设计编程规范的一些基本原则。

单片机课程设计pdf

单片机课程设计pdf

单片机课程设计pdf一、课程目标知识目标:1. 让学生掌握单片机的基本原理和结构,理解其工作流程。

2. 使学生熟悉单片机编程语言,能运用C语言或汇编语言编写简单的单片机程序。

3. 让学生了解单片机在日常生活和工业控制中的应用。

技能目标:1. 培养学生运用单片机解决实际问题的能力,学会设计简单的电路控制系统。

2. 提高学生编程能力,能对单片机程序进行调试和优化。

3. 培养学生团队协作和沟通能力,能在项目中进行有效分工与合作。

情感态度价值观目标:1. 激发学生对单片机及电子技术的兴趣,培养其探索精神和创新能力。

2. 培养学生严谨的科学态度,注重实践操作,养成良好的学习习惯。

3. 增强学生的环保意识,使其关注单片机在节能减排领域的应用。

课程性质:本课程为实践性较强的课程,结合理论教学,注重培养学生的动手能力和实际操作技能。

学生特点:学生具备一定的电子基础和编程知识,对单片机有一定了解,但实践操作能力有待提高。

教学要求:教师应结合课本内容,采用项目驱动的教学方法,引导学生通过实践操作掌握单片机相关知识,将理论知识与实际应用相结合,提高学生的综合素养。

在教学过程中,关注学生的学习进度,及时调整教学策略,确保课程目标的实现。

通过课程学习,使学生能够具备解决实际问题的能力,为未来的学习和工作打下坚实基础。

二、教学内容根据课程目标,本章节教学内容主要包括以下几部分:1. 单片机原理与结构:介绍单片机的基本组成、工作原理和性能指标,涉及课本第一章内容。

2. 单片机编程语言:讲解C语言和汇编语言在单片机编程中的应用,包括语法、语句和编程规范,对应课本第二章。

3. 单片机程序设计:通过实例讲解单片机程序设计方法,涵盖输入/输出、中断、定时器等应用,涉及课本第三章。

4. 单片机外围设备:介绍常见外围设备的使用方法,如键盘、显示、传感器等,对应课本第四章。

5. 单片机应用案例:分析单片机在实际项目中的应用,如智能家居、自动控制系统等,涉及课本第五章。

单片机程序设计编程规范

单片机程序设计编程规范

单片机程序设计编程规范单片机程序设计编程规范1.文件结构与命名规范1.1 源码文件- 所有源码文件统一使用英文小写字母命名。

- 文件名应简洁明了,能够清晰表达文件的功能。

- 文件名中可以使用下划线 (_) 连接多个单词。

1.2 头文件- 头文件名与源码文件名相同,但使用大写字母命名。

- 头文件应包含必要的宏定义、类型定义、函数声明等。

1.3 项目结构- 源码文件应按功能模块进行组织和管理,每个模块应放在独立的文件夹中。

- 在项目的根目录下添加一个README文件,对项目进行简要说明。

2.编码规范2.1 缩进与空格- 使用4个空格进行缩进,不使用Tab字符。

- 在操作符前后添加空格,增加可读性。

2.2 函数命名- 函数名使用小写字母命名,单词之间使用下划线 (_) 连接。

- 函数名应能够清晰表达函数的功能。

2.3 变量命名- 变量名使用小写字母命名,单词之间使用下划线 (_) 连接。

- 变量名应简洁明了,能够清晰表达变量的用途和含义。

- 全局变量命名应以g_开头。

2.4 常量命名- 常量名使用全大写字母命名,单词之间使用下划线(_) 连接。

2.5 注释规范- 使用注释来解释代码的意图、功能和实现细节。

- 在关键代码处添加注释,并保持注释与代码的同步更新。

- 注释应写在被注释代码的上方,并使用// 或 / /注释符号。

3.函数设计3.1 函数长度- 函数应尽量保持简短,避免超过一页纸的长度。

- 如果函数过长,应考虑将其拆分为多个较小的函数。

3.2 函数参数- 函数参数应尽量少,并且要考虑参数的顺序和类型。

- 不要在函数参数中使用全局变量,尽量使用局部变量。

3.3 函数返回值- 函数的返回值应具有明确的含义,并清晰地传达函数的执行结果。

4.异常处理与错误消息4.1 异常处理- 对可能发生异常的代码块进行适当的异常处理。

- 使用try-catch块捕获异常,并进行相应的处理或记录。

4.2 错误消息- 提供清晰、准确的错误消息,以便于调试和修复问题。

PIC单片机汇编编程规范

PIC单片机汇编编程规范

PIC汇编编程及审核规范(V1.1)一、程序命名规范程序文件名由两部分构成:一部分为产品型号或功能描述,一部分为软件版本号。

产品型号用字母描述,可为英文或中文拼音。

软件版本号为4位,前一位固定为字母”V”,后3位为数字,编写软件版本号应按照从小到大的顺序递增。

开发阶段版本号从001开始;中试之后版本号从100开始。

例如:光电感烟探测器JTY-GD-G3程序 GDG3V001电子差定温探测器JTW-ZCD-G3N程序 GWG3NV101二、程序头格式在每个文件的开始要有一个对该文件总体功能的描述,软件版本,以及作者及编写时间。

采用模版统一格式。

1.在功能描述中,除了对软件实现的功能做简要描述外,还应包括使用的单片机,晶振频率,以及主要I/O口实现的功能。

2.如果程序升级时应增加如下说明。

1)程序升级后的版本号:例如“版本号:Ver105”2)程序升级的修改作者:例如“更改人:×××”3)程序升级的修改日期:例如“更改日期:01 12 17”4)应对程序升级进行简单修改说明。

5)应给出程序增加、更改、删除项说明,每项总处数。

3.程序头如采用如下统一格式:;**************** ;* 文件名* ;**************** ;* 功能描述:;* 软件版本;* 开始编写—完成日期:;* 作者:三、子程序、标号及变量命名规则(推荐)1.子程序及标号命名规则子程序命名应使用相关含义英文。

子程序入口标号应使用子程序名相关含义、常用的英语单词(拼音)或单词(拼音)缩写。

如果一个英语单词表述不清,应使用多个英语单词缩写表示。

程序里边的标号应与执行该分支功能相关含义、常用的英语单词(拼音)或单词(拼音)缩写,如果没有确切含义,应优先选用子程序入口标号前面字母缩写加两位序号。

2.变量命名规则标志寄存器使用相关含义、常用的英语单词英文+ Flag;暂用寄存器使用:暂存对象英文缩写+Temp;计数寄存器使用暂存对象英文缩写+ Numb;其它寄存器:与存放对象相关含义、常用的英语单词(拼音)或单词(拼音)缩写。

51单片机C语言编程规范

51单片机C语言编程规范
(2)C51中的数据类型与标准C的数据类型也有 一定的区别,在C51中还增加了几种针对89C51单片 机特有的数据类型;
C51程序结构
原码工作室
(3)C51变量的存储模式与标准C中变量的存储模 式不一样,C51中变量的存储模式是与89C51单片机 的存储器紧密相关;
(4)C51与标准C的输入输出处理不一样,C51中 的输入输出是通过89C51串行口来完成的,输入输出 指令执行前必须要对串行口进行初始化;
Int a ;
部变量。在一个函数体 内,要使用一个已在该函数体外或别的程序中定义过的 外部变量时,该变量在该函数体内要用extern说明。外部 变量被定义后分配固定的内存空间,在程序整个执行时 间内都有效,直到程序结束才释放。
3.static:
本章主要以KEIL编译器介绍89C51单片机C语言 程序设计。
C51程序结构
原码工作室
C51的语法规定、程序结构及程序设计方法都与 标准的C语言程序设计相同,但C51程序与标准的C 程序在以下几个方面不一样:
(1)C51中定义的库函数和标准C语言定义的库 函数不同。标准的C语言定义的库函数是按通用微型 计算机来定义的,而C51中的库函数是按89C51单片 机相应情况来定义的;
源码工作室
原码工作室
学习单片机C语言的必要性
随着单片机性能的不断提高,C语言编译调 试工具的不断完善,以及现在对单片机产品辅助 功能的要求、对开发周期不断缩短的要求,使得 越来越多的单片机编程人员转向使用C语言,因 此有必要在单片机课程中讲授“单片机C语言”。
C语言编程的优势
原码工作室
1.语言简洁、紧凑,使用方便、灵活。
signed int数据用补码表示。
原码工作室

51单片机汇编语言程序设计

51单片机汇编语言程序设计
23:24
单片机原理与接口技术
中北大学电子科学技术专业
返回目录
8
4.1.3 汇编语言的规范
2.伪指令
---伪指令 伪指令ORG 伪指令
MCS-51系列单片机的常用伪指令有 ORG、 MCS-51系列单片机的常用伪指令有:ORG、 系列单片机的常用伪指令有: END、EQU、DB、DW、DS和BIT等 END、EQU、DB、DW、DS和BIT等。
23:24
单片机原理与接口技术
中北大学电子科学技术专业
返回目录
9
4.1.3 汇编语言的规范
(2)汇编结束伪指令END 汇编结束伪指令END
格式:[标号:] 格式: 标号:] END [表达式] [表达式 表达式]
---伪指令 伪指令END 伪指令
功能:结束汇编。汇编程序遇到END伪指令后即结束汇 功能:结束汇编。汇编程序遇到END伪指令后即结束汇 编。处于END之后的程序,汇编程序不予处理。 处于END之后的程序 汇编程序不予处理。 之后的程序, ORG 2000H 如: START: MOV A, #00H … END START ;表示标号START开始的程序段结束。 表示标号START开始的程序段结束 开始的程序段结束。
以上伪指令经汇编以后, 以上伪指令经汇编以后,将从 1010H开始的若干内存单元赋值。 1010H开始的若干内存单元赋值。 开始的若干内存单元赋值
23:24
单片机原理与接口技术
中北大学电子科学技术专业
返回目录
12
4.1.3 汇编语言的规范
(5)定义字伪指令 )定义字伪指令DW
[标号:] 标号: DW 16位二进制数表 16位二进制数表
(7)位定义伪指令BIT 位定义伪指令BIT
  1. 1、下载文档前请自行甄别文档内容的完整性,平台不提供额外的编辑、内容补充、找答案等附加服务。
  2. 2、"仅部分预览"的文档,不可在线预览部分如存在完整性等问题,可反馈申请退款(可完整预览的文档不适用该条件!)。
  3. 3、如文档侵犯您的权益,请联系客服反馈,我们会尽快为您处理(人工客服工作时间:9:00-18:30)。

单片机程序设计编程规范本规范适用于松翰科技8-bit MCU部门汇编程序编写准则,同样适用于代理商及重要客户工程师编程规范参考。

本规范的目的为统一编程风格,保证程序编写质量,提高程序的可移植性和维护性。

大部分的规范严格,品质要求高的软件公司对员工编写代码的风格都有硬性规定,例如缩排的使用,TAB的长度,函数变量的命名方式.这些规定的明显好处是可以统一规范不同程序员所编制的代码,提升程序代码的可读性与可维护性,同时统一格式的编程风格也为code review 提供方便.目录一、设计总则二、排版风格三、程序可读性及可维护性四、注释五、变量命名规则六、常量命名规则七、标号命名规则八、文件命名规则及文件分割九、标准程序模块十、附录一、一、设计总则设计总则1.程序质量的评估程序的优劣可以从两个方面进行评估,定量指标和定性指标。

定量指标包括:1)程序代码执行效率;2)程序占用资源多少。

定性指标包括:1)可调试性,即是否方便排除程序语法错误;2)可测试性,即是否方便验证程序功能的正确性;3)可维护性,即是否方便程序的修改和升级;4)可移植性;5)可读性。

2、程序架构为了便于维护和移植,推荐使用层次化的软件设计方法。

可把整个软件分为三层:应用层、界面层和底层驱动层。

各层之间的关系如下图所示。

层次化设计说明:1)底层驱动层主要包含直接和硬件相关的驱动程序,如数码管显示、按键、峰鸣器、继电器和电机控制等。

底层的各个模块间要保持各自的独立性,不产生直接的数据交互,底层也不直接访问应用层,如果有需要,都要通过界面层进行数据交互。

2)界面层主要提供数据交互,为应用层和底层驱动之间以及底层驱动层各模块之间提供数据的交互。

3)应用层主要完成具体功能的实现,它要通过界面层控制底层驱动层各模块来完成所需功能,而不能越过界面层直接访问底层驱动层。

所有的用户接口要在应用层来实现.4)一个好的架构必须将底层硬件包装起来,为应用程序提供一组丰富的函数操作(buffer or parameter),例如在中断的处理中,应用程序不需要资料中断的堆栈如何保护不需要知道地址操作,只需要读取中断产生的旗标动作.5)在即时性软件系统里面,对达到高效率的实时性与反应力,所以程序使用大量的事件触发方式来设计任务.事件有可能来自外部的触发(key ,rx data ,sensor detect,…)也可能是系统内部自行产生的(Timer,alarm,flag),与事件触发方式相对应的是定时查询方式(polling),一般来说polling 效率较差因为有多余的动作而且系统反应时间与查询polling 时间间隔有关,但是在小型的MCU 系统里面用Polling 方式反而简单许多3、设计基本原则1)尽量减少各个子程序功能模块间的耦合度(耦合度是指一个程序的执行对另一个程序的影响力),保证各自的独立性。

一般情况下,建议子程序模块功能的划分要尽可能细化,功能尽量单一,减少子程序模块间的数据交互。

2)在满足功能需求的情况下,可适当牺牲代码的执行速度,以保证程序的透明度。

3)主要子程序模块间的交互,要通过特定的界面跟应用层进行沟通,可使用FIFO (First in ,First out )或是Buffer 两种方式。

每种子程序模块都可以有自己的FIFO 。

例如:就按键来说,一般有Key buffer、Key FIFO或直接进入AP FIFO三种设计方式。

Key buffer:一般用于保存数字按键信息。

例如:在电话机的设计中,需要记录按键内容用于LCD显示、最后数字确认、数字存储等,这时候需要把按键值的信息(0123456789*#)记录在Key buffer中;Key FIFO:一些功能按键可以将相应信息列入到Key FIFO中,等待应用层的取用,这样可根据不同的工作模式进行不同的处理及动作。

这些类似的观念可以应用在许多周边中:输入类:Key、RF Data input、UART data input、Switch input等;输出类:LCD display、LED display、UART data output等。

APP FIFO(应用界面层):主要是将发生的事件储存在APP FIFO里面等待适当的时间依序处理,不然有可能造成系统在某一程序物件里面循环,从而降低系统的实时性(Real-Time)。

4)每个子程序模块只能有唯一一个程序入口地址在程序的首部,只能有唯一一个程序出口地址在程序的尾部。

例如:以下的写法是不规范的(两个RET出口,存在调试时不易设立断点,程序可读性降低等问题):lable:b0bts0fzret…clr yret应该改为(只有一个出口位置,标号为lable90,便于程序检查):lable:b0bts0fzjmp lable90….clr ylable90:ret5)上电复位时要对所有的RAM空间进行初始化(建议用户寄存器清零,系统寄存器进行必要设定),不要使用未经初始化的变量。

RAM未经过完整的初始化,容易导致程序执行的不确定性,这一不良现象往往在批量生产中有所体现。

(这点是工程师经常犯错的地方,须特别注意)6)系统中如果需要等待一些未知的应答信号,如通信或等待输入信号时,必须进行超时或异常处理,以防止程序进入“死等”状态。

例如在红外接收中,由于信号的突然消失或干扰从而无法得到一帧完整或正确的信息,这时需要复位接收程序的入口条件并退出接收程序,而不是一直等待信号的来临。

不然无法进行下次接收甚至会影响到其它程序的执行。

7)通过对系统数据结构的划分与组织的改进,以及对程序算法的优化来提高空间效率。

这种方式是解决软件空间效率的根本办法。

8)保证循环体内的工作量最小化。

应仔细考虑循环体内的语句是否可以放在循环体之外,使循环体内工作量最小,从而提高程序的执行效率。

9)在多重循环中,应将最忙的循环放在最内层。

10)中断处理程序应尽量短。

有效的作法为:在中断中进行标记,在主程序中进行处理。

但一些实时性要求较高的程序例外。

此外,进入中断时应该保存涉及到的变量和寄存器。

11)看门狗的正确使用。

看门狗主要用于微控制器死机时的时间溢出复位,需要程序适时清除。

正确的处理方式为:整个系统程序中尽量保证只有一处清看门狗位置,而且应处在主循环的主干位置。

切记不可在定时中断中清狗,因为微控制器有时只是在主循环中死掉。

(所有AC电源的应用程序都必须强迫加入看门狗选项尤其是条件式的看门狗有利于系统发生异常后的重启动)排版风格二、二、排版风格1、程序采用缩进风格编写,缩进为1个Tab键,1个Tab键定义为8个空格位。

2、程序中的标号要从第一列开始书写。

以“.”开头的预编译命令也要从第一列开始书写,其他预编译命令采用缩进风格编写。

例如:1)以“.”开头的预编译命令要从第一列开始书写,其他预编译命令采用缩进风格书写。

.LIST;从第一列开始书写INCLUDESTD macro1.h.CONSTNUMBER EQU55h.DATAwk00DS1.CODEORG0h2)标号要从第一列开始书写。

main:;从第一列开始…jmp main;缩进8个空格位3)变量或常量的定义采用缩进风格。

例如:.DATAkeybuf DS1.CONSTNUMBER EQU84)定义变量或常量时,变量名或常量名与命令符之间使用2个Tab键(相当于16个空格位)分开,命令符与后面的操作数用1个Tab键(相当于8个空格位)分开。

例如:keybuf DS1NUMBER EQU55h5)操作码与操作数之间用1个Tab键(相当于8个空格位)分开。

ORG80hmov a,NUMBERtable:DW1234h6.)程序中两个操作数之间用一个“,”作为分隔符,“#”号与立即数之间不需要分隔符。

例如:mov a,#55h7)标号要单独占一行。

8)相对独立的程序块之间必须加空行。

例如:ORG10hINCLUDE sys.asmINCLUDE int.asmINCLUDE key.asm9)程序语句后面若有注释,所有的注释要遵守上下对齐的原则。

例如:b0mov l,#7fh;use dp0x(hl)pointermov a,#00;set pointer=007fh应该书写为:b0mov l,#7fh;use dp0x(hl)pointermov a,#00;set pointer=007fh程序可读性与可维护性三、三、程序可读性与可维护性1.程序中的语句、标号、变量使用小写英文字母,常量与预编译命令使用大写英文字母,以便和一般的语句进行区分。

例如:NUMBER EQU55h.DATAaccbuf DS1.CODE…mov a,#NUMBER2.表示不同进制的立即数,要在立即数后面加上不同的进制符号。

例如:mov a,#00100011bmov a,#23h不建议使用:mov a,#0x233.一般情况下,变量和常量要分开定义,不要混在一起。

变量在”.DATA”段中定义,采用命令符“DS”,常量在”.CONST”段中定义,采用命令符“EQU”。

.CONSTNUMBER EQU10.DATAaccbuf DS14.程序中不使用未定义或意义不明确的常量。

例如:下面的赋值方法要避免使用:…mov a,#3;不要直接使用意义不明确的数字,在常量中做定义mov r,a…建议采用如下赋值方法:.CONSTNUMBER EQU3;循环次数….CODE…mov a,#NUMBERmov r,a5.整个程序的结尾要以“ENDP”语句结束。

6.当一段代码在程序中有多个地方使用时,建议采用子程序调用或宏命令的方式来替代。

如此,对该代码段的修改就可在一处完成,增强代码的可维护性。

7.程序中关系较为密切的子程序代码尽可能相邻。

8.避免程序中的垃圾代码,预留代码应以注释的方式出现。

程序中的垃圾代码不仅占用额外的空间,而且还可能影响到程序的功能与性能,很可能给程序的测试、维护等造成不必要的麻烦。

注释四、注释四、1.程序应该包括两个部分注释,说明部分和语句注释。

一般情况下,源程序有效注释量必须在30%以上。

2.说明部分:1)源文件说明部分位于每个源文件的最前面,主要描述:文件名、作者、生成日期、联络方式、功能描述、版本号、软硬件平台、版权说明、修改记录等的简要说明,以英文书写。

例如:/*************************************************File name:;文件名Author:;作者Date:;日期Email:;邮箱地址Description:;功能描述Version:;版本号Hardware&IDE;软硬件平台Copyright(C),SONIX TECHNOLOGY Co.,Ltd.History:;修改记录*************************************************/2)子程序说明部分位于每个子程序的最前面,主要描述:子程序名称、功能、设计原理、所用变量、入口条件、出口信息、调用模块、堆栈层数、影响资源、算法简述、使用说明和修改记录等。

相关文档
最新文档