C语言编程规范

作者在 2010-04-25 15:51:46 发布以下内容
觉得还可以就抄过来了。。呵呵。


基本要求 
1.1 程序结构清 析,简单易懂,单个函数程序行数不 得超过100行。  
1.2 打算干什么,要简单,直接了当,代码精简,避免垃圾程序。  
1.3 尽量使用标准库 函数和公共函数。  
1.4 不要随意定义全局变量,尽量使用局部变量。  
1.5 使用括号以避免 二义性。  

2.可读性要求  
2.1 可读性第一,效率第二。  
2.2 保持注释与代码完全一致。  
2.3 每 个源程序文件,都有 文件头说明,说明规格见规范。  
2.4 每个函数,都有函数头说明,说明规格见规范。  
2.5 主要变量(结构、联合、类或 对象)定义或引用时,注释能反映其含义。  
2.7 常量定义(DEFINE)有相应说明。  
2.8 处理过程的每个阶段都有相关注释 说明。  
2.9 在典型算法前都有注释。  
2.10 利用缩进来显示程序的逻辑结构,缩进量一致并以Tab键为单位,定义Tab 为 6个字节。  
2.11 循环、分支层次不要超过五层。  
2.12 注释可以与语句在同一行,也可以在上行。  
2.13 空行和空 白字符也是一种特殊注释。  
2.14 一目了然的语句不加注释。  
2.15 注释的作用范围可以为:定义、引用、条件分支以 及一段代码。  
2.16 注释行数(不包括程序头和函数头说明部份)应占总行数的 1/5 到 1/3 。  


3. 结 构化要求  

3.1 禁止出现两条等价的支路。  
3.2 禁止GOTO语句。  
3.3 用 IF 语句来强调只执行 两组语句中的一组。禁止 ELSE GOTO 和 ELSE RETURN。  
3.4 用 CASE 实现多路分支。  
3.5 避免 从循环引出多 个出口。  
3.6 函数只有一个出口。  
3.7 不使用条件赋值语句。  
3.8 避免不必要的分支。  
3.9 不 要轻易用条件分支去替换逻辑表达式。  

4. 正 确性与容错性要求  

4.1 程序首先是正确,其次是优美  
4.2 无法证明你的程序没有错误,因此在编写完一段程序后,应先 回头检查。  
4.3 改一个错误时可能产生新的错误,因此在修改前首先考虑对其它程序的影响。  
4.4 所有变量在调用前必须被初始 化。  
4.5 对所有的用户输入,必须进行合法性检查。  
4.6 不要比较浮点数的相等,  
如: 10.0 * 0.1 == 1.0 , 不 可靠  
4.7 程序与环境或状态发生关系时,必须主动去处理发生的意外事件,如文件能否  
逻辑锁定、打印机是否联机等。  
4.8 单 元测试也是编程的一部份,提交联调测试的程序必须通过单元测试。
学习历程 | 阅读 909 次
文章评论,共0条
游客请输入验证码