1 / 10
文档名称:

VC编码规范.doc

格式:doc   大小:62KB   页数:10页
下载后只包含 1 个 DOC 格式的文档,没有任何的图纸或源代码,查看文件列表

如果您已付费下载过本站文档,您可以点这里二次下载

分享

预览

VC编码规范.doc

上传人:mh900965 2018/4/15 文件大小:62 KB

下载得到文件列表

VC编码规范.doc

文档介绍

文档介绍:教研室C++编程规范
目录
1. 基本要求 3
2. 可读性要求 3
3. 结构化要求 4
4. 正确性与容错性要求 4
5. 可重用性要求 4
附:C++ 编程范例 5
1. 基本要求 
程序结构清析,简单易懂,单个函数的程序行数一般不得超过100行。 
打算干什么,要简单,直接了当,代码精简,避免垃圾程序。
尽量使用标准库函数和公共函数。
不要随意定义全局变量,尽量使用局部变量。
表达式书写中提倡使用括号以避免二义性。
2. 可读性要求
可读性第一,效率第二。
保持注释与代码完全一致。
每个源程序文件,都有文件头说明,说明规格见附件。
每个函数,都有函数头说明,说明规格见附件。
主要变量(结构、联合、类或对象)定义或引用时,注释能反映其含义。 
常量定义(DEFINE)有相应说明。
处理过程的每个阶段都有相关注释说明。
在典型算法前都有注释。
利用缩进来显示程序的逻辑结构,缩进量一致并以Tab键为单位。
循环、分支层次不要超过五层。
注释可以与语句在同一行,也可以在上行。
空行和空白字符也是一种特殊注释。
一目了然的语句不加注释。
注释的作用范围可以为:定义、引用、条件分支以及一段代码。
注释行数(不包括程序头和函数头说明部份)应占总行数的 1/5 到 1/3 。
3. 结构化要求
禁止出现两条等价的支路。
禁止GOTO语句。 
用 IF 语句来强调只执行两组语句中的一组。禁止 ELSE GOTO 和 ELSE RETURN。
用 CASE 实现多路分支。
避免从循环引出多个出口。 
函数只有一个出口。
不使用条件赋值语句。 
避免不必要的分支。
不要轻易用条件分支去替换逻辑表达式。
4. 正确性与容错性要求 
程序首先是正确,其次是优美。
无法证明你的程序没有错误,因此在编写完一段程序后,应先回头检查。
改一个错时可能产生新的错误,因此在修改前首先考虑对其它程序的影响。
所有变量在调用前必须被初始化。
对所有的用户输入,必须进行合法性检查。
不要比较浮点数的相等,如: * == , 不可靠。
程序与环境或状态发生关系时,必须主动去处理发生的意外事件,如文件能否逻辑锁定、打印机是否联机等。
单元测试也是编程的一部份,提交联调测试的程序必须通过单元测试。
5. 可重用性要求 
重复使用的完成相对独立功能的算法或代码应抽象为公共控件或类。
公共控件或类应考虑OO思想,减少外界联系,考虑独立性或封装性。
公共控件或类应建立使用模板。
附:C++ 编程范例
1适用范围
本标准适用于教研室利用VC++进行软件程序开发的人员。
2变量命名
命名必须具有一定的实际意义,形式为xAbcFgh,x由变量类型确定,Abc、Fgh表示连续意义字符串,如果连续意义字符串仅两个,可都大写,如OK。
具体例