软件开发规范.docVIP

PAGE5

重庆思恩科信息技术有限责任公司 软件开发规范

THKSoft2011第PAGE1页,共NUMPAGES\*Arabic28页

软件开发规范

目录

TOC\o1-3\h\z\u1 目标 3

2 概述 3

3 总体要求 3

3.1 程序结构化 3

3.2 代码可读性 3

3.3 代码结构化 3

3.4 正确性与容错性 4

4 编码规范 4

4.1 文件结构 4

4.1.1 C#文件 4

4.1.2 目录结构 4

4.2 缩进 5

4.2.1 换行 5

4.2.2 空格 6

4.3 注释 6

4.3.1 模块注释 6

4.3.2 单行注释 7

4.3.3 类注释 7

4.3.4 方法注释 7

4.4 声明 7

4.4.1 单行声明变量数 7

4.4.2 初始化 8

4.4.3 类和接口声明 8

4.5 功能语句 9

4.5.1 简单逻辑 9

4.5.2 if-else语句 9

4.5.3 For/Foreach语句 9

4.5.4 While/do-while语句 10

4.5.5 Switch语句 10

4.5.6 Try-catch语句 10

4.6 空白 11

4.6.1 空白行 11

4.6.2 参数条件之间的空白 11

4.6.3 表格式的样式 12

4.7 命名规范 12

4.7.1 大写 12

Pascal风格 12

骆驼规则 12

大写风格 12

缩写 12

措词 13

避免类型名称混淆 14

4.7.2 命名方法 15

页面命名 15

命名空间命名 15

类命名 16

接口命名 16

枚举命名 16

常量命名 16

参数命名 16

变量命名 17

方法命名 17

0 属性命名 17

1 事件命名 17

2 静态字段命名 17

3 长项和常用项的命名 17

4 控件命名 18

5 大写风格 23

4.8 开发习惯 23

4.8.1 可见性 23

4.8.2 不要硬编码数字 23

4.9 代码示例 24

4.9.1 作用域（“{}”）示例 24

5 参考 25

6 附录 25

6.1 XML注释标记的使用 25

7 修改历史 28

目标

为重庆思恩科信息技术有限责任公司的技术部制定一个统一的编码规范，最大限度减少不同程序员开发的代码间的差异。

概述

为了使应用程序的结构和编码风格标准化，便于阅读和理解编码，以提高开发效率和产品的标准化，制订一套开发规范和标准势在必行。此外，好的编码约定可使源代码严谨、可读性强且意义清楚，与其它语言约定相一致，并且尽可能的直观。希望开发人员严格遵守此套开发规范和标准，并落实到自己的程序中。

本规范主要针对.NET程序员，但是其中许多规则同时适用于其他语言的程序员。

总体要求

程序结构化

程序结构清晰，函数功能简单易懂（单个函数的代码行数不超过100行）

代码可读性

保持注释与代码完全一致

每个源程序文件，都有文件头说明，详细见下节

每个函数，都有函数头说明，详细见下节

主要变量（结构、联合、类或对象）定义或引用时，注释能反映其含义

处理过程的每个阶段都有相关注释说明

在典型算法前都有注释,同时算法在满足要求的情况下尽可能简单

利用缩进来显示程序的逻辑结构，缩进量一致并以Tab键为单位，定义Tab为4个字节

循环、分支层次一般不应超过五层

代码简单的分支应该写在前面

不允许同行出现两个语句

空行和空白字符也是一种特殊注释

一目了然的语句不加注释

注释的作用范围可以为：定义、引用、条件分支以及一段代码

常量定义（DEFINE）有相应说明

代码结构化

禁止GOTO语句

用CASE实现多路分支

避免不必要的分支

用IF语句来强调只执行两组语句中的一组。尽量不使用ELSERETURN

尽量避免从循环引出多个出口

正确性与容错性

所有变量在调用前必须被初始化

不要比较浮点数的相等，如：10.0*0.1==1.0，不可靠

访问外部资源(数据库，外部文件)时使用规范的