资料
  • 资料
  • 专题
周立功文档写作规范
推荐星级:
时间:2019-12-25
大小:62KB
阅读数:157
上传用户:二不过三
查看他发布的资源
下载次数
0
所需E币
5
ebi
新用户注册即送 300 E币
更多E币赚取方法,请查看
close
资料介绍
详细 程序代码写作规范(草案)(版本:1.0) • 基本要求 程序结构清析,简单易懂,单个函数的程序行数不得超过100行。 打算干什么,要简单,直接了当,代码精简,避免垃圾程序。 尽量使用公共函数,c51的标准库函数谨慎使用。 不要随意定义全局变量,尽量使用局部变量。 使用括号以避免二义性。 非万不得已不要使用浮点运算。一般的小数运算可以使用定点数实现。 • 可读性要求 可读性第一,效率第二。 保持注释与代码完全一致。 每个源程序文件,都有文件头说明,说明规格见规范。 每个函数,都有函数头说明,说明规格见规范。 主要变量(结构、联合、类或对象)定义或引用时,注释能反映其含义。 常量定义(define)有相应说明。 处理过程的每个阶段都有相关注释说明。 在典型算法前都有注释。 利用缩进来显示程序的逻辑结构,缩进量一致并以4个空格为单位。 循环、分支层次不要超过五层。 注释可以与语句在同一行,也可以在上行。 空行和空白字符也是一种特殊注释。 一目了然的语句不加注释。 注释的作用范围可以为:定义、引用、条件分支以及一段代码。 • 结构化要求 禁止出现两条等价的支路。 非必要不要使用goto语句。goto一般用于从内循环直接跳到循环外部、检测到错误直接 跳到错误处理程序。影响可读性时禁止使用goto语句。 用 if 语句来强调只执行两组语句中的一组。 用 case 实现多路分支。 避免从循环引出多个出口。 尽量减少函数的出口。 避免不必要的分支。 不要轻易用条件分支去替换逻辑表达式。 • 正确性与容错性要求 程序首先是正确,其次是优美。 无法证明你的程序没有错误,因此在编写完一段程序后,应先回头检查。 改一个错误时可能产生新的错误,因此在修改前首先考虑对其它程序的影响。 所有变量在调用前必须被初始化。 对所有的用户输入,必须进行合法性检查。 不要……
版权说明:本资料由用户提供并上传,仅用于学习交流;若内容存在侵权,请进行举报,或 联系我们 删除。
相关评论 (下载后评价送E币 我要评论)
没有更多评论了
  • 可能感兴趣
  • 关注本资料的网友还下载了
  • 技术白皮书