单片机程序设计编程规范(7)

Hardware&IDE

Copyright(C),SONIXTECHNOLOGYCo.,Ltd.

History:

*************************************************/;软硬件平台;修改记录

2)子程序说明部分位于每个子程序的最前面，主要描述：子程序名称、功能、设计原理、所用变量、入口条件、出口信息、调用模块、堆栈层数、影响资源、算法简述、使用说明和修改记录等。

例如：

/**************************************************

Subroutine:;子程序名称

Description:;子程序功能的描述

Principium:;程序设计原理

Calls:;被本子程序调用的子程序清单Variables:;本子程序中所用到的临时变量

Input:;子程序调用所需要基本参数的说明Output:;子程序调用后运算结果的说明Stack:;占用的堆栈层数

History:;修改记录

*************************************************/

3.边写代码边注释，修改代码的同时修改相应注释，以保证注释与代码的一致性。不再有用的注释要删除。

4.要避免在注释中使用缩写，特别是非常用缩写。

5.程序在必要的地方必须有注释，注释要准确、易懂、简洁。注释要有意义，如果有需要，还要详细描述相关含义。

例如：

以下是无意义的注释

mova,#5;把5赋给acc

movwk00,a;把acc赋给wk00

应该如下注释：

mova,#5;设置循环次数为5次

movwk00,a

6.注释应与其描述的代码相近，对代码的注释应放在其上方或右方（对单条语句的注释）的相邻位置，不可放在下方，如放于上方则需与其上面的代码用空行隔开。

例如：

clrwk00

;CheckReadindex=FiFoLimit

cmprsa,r;IsReadindex=Limit

jmp@f

7.注释格式尽量统一，对多行注释建议使用“/*……*/”，对单行的注释建议使用“;”。

8.注释应考虑程序易读及外观排版因素，语言尽量统一。对不能进行准确英文表达的建议使用中文。

9.对有含义的变量、常量，如果其命名不是充分自注释的，在声明时都必须加以注释，说明其含义。

百度搜索“77cn”或“免费范文网”即可找到本站免费阅读全部范文。收藏本站方便下次阅读，免费范文网，提供经典小说教育文库单片机程序设计编程规范(7)在线全文阅读。