本人前一段时间写的，大家交流。转载请注明：http://blog.csdn.net/yu_nan88

代码编写规范(C#)

V1.2

2004 年 11 月 04 日

类别

文件名：

代码编写规范

版本号：

V1.2

版本日期：

2004-11-04

作者：

Nick

日期：

2004-11-04

目 录

1   目的. 4

2   范围. 4

3   注释规范. 4

3.1   概述. 4

3.2   自建代码文件注释. 4

3.3   模块（类）注释. 5

3.4   类属性注释. 5

3.5   方法注释. 5

3.6   代码间注释. 6

4   命名总体规则. 6

5   命名规范. 6

5.1   变量（Variable）命名. 6

5.2   常量命名. 8

5.3   类（Class）命名. 8

5.4   接口（Interface）命名. 9

5.5   方法（Method）命名. 9

5.6   命名空间（NameSpace）命名. 9

6   编码规则. 9

6.1   错误检查规则. 9

6.2   大括号规则. 9

6.3   缩进规则. 9

6.4   小括号规则. 10

6.5   If Then Else规则. 10

6.6   比较规则. 10

6.7   Case规则. 11

6.8   对齐规则. 11

6.9   单语句规则. 11

6.10    单一功能规则. 11

6.11    简单功能规则. 11

6.12    明确条件规则. 11

6.13    选用FALSE规则. 11

6.14    独立赋值规则. 12

6.15    定义常量规则. 12

6.16    模块化规则. 12

6.17    交流规则. 12

7   编程准则. 12

7.1   变量使用. 12

7.2   数据库操作. 12

7.3   对象使用. 13

7.4   模块设计原则. 13

7.5   结构化要求. 13

7.6   函数返回值原则. 13

8   代码包规范. 14

8.1   代码包的版本号. 14

8.2   代码包的标识. 14

9   代码的控制. 15

9.1   代码库/目录的建立. 15

9.2   代码归档. 15

10      输入控制校验规则. 15

10.1    登陆控制. 15

10.2    数据录入控制. 15

附件1：数据类型缩写表. 16

附件2：服务器控件名缩写表. 16

1        目的

为了统一公司软件开发的设计过程中关于代码编写时的编写规范和具体开发工作时的编程规范，保证代码的一致性，便于交流和维护，特制定此规范。

2        范围

本规范适用于开发组全体人员，作用于软件项目开发的代码编写阶段和后期维护阶段。

3        注释规范

3.1      概述

a)       注释要求英文及英文的标点符号。

b)       注释中，应标明对象的完整的名称及其用途，但应避免对代码过于详细的描述。

c)           每行注释的最大长度为100个字符。

d)           将注释与注释分隔符用一个空格分开。

e)       不允许给注释加外框。

f)           编码的同时书写注释。

g)           重要变量必须有注释。

h)       变量注释和变量在同一行，所有注释必须对齐，与变量分开至少两个“Tab”键。

如：int  m_iLevel,m_iCount;     // m_iLevel ....tree level

[1] [2] [3] [4] [5] [6] [7] [8] [9]  下一页