周立功代码规范_第1页
周立功代码规范_第2页
周立功代码规范_第3页
周立功代码规范_第4页
周立功代码规范_第5页
已阅读5页，还剩1页未读， 继续免费阅读

下载本文档

版权说明：本文档由用户提供并上传，收益归属内容提供方，若内容存在侵权，请进行举报或认领

文档简介

程序代码写作规范（草案） （版本：1.0） 基本要求 (1) 程序结构清析，简单易懂，单个函数的程序行数不得超过 100 行。 (2) 打算干什么，要简单，直接了当，代码精简，避免垃圾程序。 (3) 尽量使用公共函数，c51 的标准库函数谨慎使用。 (4) 不要随意定义全局变量，尽量使用局部变量。 (5) 使用括号以避免二义性。 (6) 非万不得已不要使用浮点运算。一般的小数运算可以使用定点数实现。 可读性要求 (1) 可读性第一，效率第二。 (2) 保持注释与代码完全一致。 (3) 每个源程序文件，都有文件头说明，说明规格见规范。 (4) 每个函数，都有函数头说明，说明规格见规范。 (5) 主要变量（结构、联合、类或对象）定义或引用时，注释能反映其含义。 (6) 常量定义（define）有相应说明。 (7) 处理过程的每个阶段都有相关注释说明。 (8) 在典型算法前都有注释。 (9) 利用缩进来显示程序的逻辑结构，缩进量一致并以 4 个空格为单位。 (10) 循环、分支层次不要超过五层。 (11) 注释可以与语句在同一行，也可以在上行。 (12) 空行和空白字符也是一种特殊注释。 (13) 一目了然的语句不加注释。 (14) 注释的作用范围可以为：定义、引用、条件分支以及一段代码。 结构化要求 (1) 禁止出现两条等价的支路。 (2) 非必要不要使用 goto 语句。 goto 一般用于从内循环直接跳到循环外部、检测到错 误直接跳到错误处理程序。影响可读性时禁止使用 goto 语句。 (3) 用 if 语句来强调只执行两组语句中的一组。 (4) 用 case 实现多路分支。 (5) 避免从循环引出多个出口。 (6) 尽量减少函数的出口。 (7) 避免不必要的分支。 (8) 不要轻易用条件分支去替换逻辑表达式。 正确性与容错性要求 (1) 程序首先是正确，其次是优美。 (2) 无法证明你的程序没有错误，因此在编写完一段程序后，应先回头检查。 (3) 改一个错误时可能产生新的错误，因此在修改前首先考虑对其它程序的影响。 (4) 所有变量在调用前必须被初始化。 (5) 对所有的用户输入，必须进行合法性检查。 (6) 不要比较浮点数的相等，如： 10.0 * 0.1 = 1.0 ， 不可靠。 (7) 函数对接受的参数应该进行合法性检查。 (8) 单元测试也是编程的一部份，提交联调测试的程序必须通过单元测试。 (9) 尽量不要使用=作为判断条件，应该用=,或、 :、 .、 、 等运算符前后，及(假定串行口使用定 时器 1） 。 (8) 中断服务程序尽可能短。 (9) 禁止使用递归模式. (10) 一般应用禁止使用浮点运算。 (11) 函数参数一般应该少于 3 个。 针对汇编的补充 (1) 尽量使用宏汇编，不要使用小汇编。 (2) 使用小汇编时不要使用 equ 分配变量，要使用 data、idata、xdata、bit
人人文库> 全部分类> 教育资料 > 辅导培训

温馨提示

  • 1. 本站所有资源如无特殊说明，都需要本地电脑安装OFFICE2007和PDF阅读器。图纸软件为CAD,CAXA,PROE,UG,SolidWorks等.压缩文件请下载最新的WinRAR软件解压。
  • 2. 本站的文档不包含任何第三方提供的附件图纸等，如果需要附件，请联系上传者。文件的所有权益归上传用户所有。
  • 3. 本站RAR压缩包中若带图纸，网页内容里面会有图纸预览，若没有图纸预览就没有图纸。
  • 4. 未经权益所有人同意不得将文件中的内容挪作商业或盈利用途。
  • 5. 人人文库网仅提供信息存储空间，仅对用户上传内容的表现方式做保护处理，对用户上传分享的文档内容本身不做任何修改或编辑，并不能对任何下载内容负责。
  • 6. 下载文件中如有侵权或不适当内容，请与我们联系，我们立即纠正。
  • 7. 本站不保证下载资源的准确性、安全性和完整性, 同时也不承担用户因使用这些下载资源对自己和他人造成任何形式的伤害或损失。

最新文档

评论

0/150

提交评论