C#代码编写规X

目录 1 目的 2
1 目的 3
2 适应 X 围 3
3 术语及缩略语 4
4 规 X 内容 4
4.1 命名总体规则 4
4.2 命名规 X4
4.2.1 变量命名4
4.2.2 常量命名6
4.2.3 类(Class)命名6
4.2.4接口(Interface)命名7
4.2.5 方法(Method)命名 7
4.2.6 命名空间(NameSpace)命名7
4.2.7属性(Property)命名7
4.3 注释规 X7
4.3.1 概述7
4.3.2 自建代码文件注释8
4.3.3模块(类)注释9
4.3.4 类属性注释9
4.3.5 方法注释10
4.3.6代码间注释10
4.4 编码规则 10
4.4.1错误检查规则10
4.4.2 大括号规则11
4.4.3 小括号规则11
4.4.4 缩进规则11
4.4.5 对齐规则11
4.4.6 比较规则11
4.4.7 Case规则 12
4.4.8 If … Else规则 12
4.4.9 单语句规则12
4.4.10 单一功能准则12
4.4.11 简单功能准则12
4.4.12 明确条件规则12
4.4.13 选用False 规则 13
4.4.14独立赋值规则13

4.4.15 定义常量规则13
4.4.16模块化规则13
4.4.17 交流规则13
4.5 编程准则 14
4.5.1 变量使用14
4.5.2 数据库操作14
4.5.3 对象使用14
4.5.4模块设计原则14
4.5.5 结构化要求14
4.5.6 函数返回值原则15
中文写代码软件4.6 代码包规 X15
4.6.1代码包的版本号15
4.6.2代码包的标识16
4.7 代码控制 17
4.7.1代码库/目录的建立17
4.7.2代码归档17
附件 1：数据类型缩写表 17
附件 2：控件名缩写表 18
a、.NET控件 18
b、html 控件 19
c、ADO.NET控件20
1 目的
a)  为了统一公司软件开辟设计过程的编程规 X；
b)  使开辟人员能方便的理解每一个目录、变量、控件、类、方法的意义；
c)  为了保证编写出的程序都符合相同的规 X，保证一致性、统一性而建立的程
序编码规 X；
d)  编码规 X 和约定必须能明显改善代码可读性，并有助于代码管理；

2 适应 X 围
本规 X 合用于企业所有基于.NET 平台的软件开辟人员，作用于软件项目开 发的代码编写阶段和后期维护阶段。
3 术语及缩略语
4 规 X 内容
4.1 命名总体规则
a)  名字应该能够标识事物的特性。
b) 名字一律使用英文单词，而不能为拼音。
c) 名字尽量不使用缩写，除非它是众所周知的。
d) 名字可以有两个或者三个单词组成，但不应多于三个，控制在 3 至 30 个
字母以内。
e)  在名字中， 多个单词用大写第一个字母 (其它字母小写) 来分隔。 例如：
IsSuperUser。
f)  名字尽量使用前缀而不是后缀。
g) 名字中的单词尽量使用名词，如有动词，也尽量放在后面。例如：
FunctionUserDelete (而不是 FunctionDeleteUser)。

4.2 命名规 X
4.2.1 变量命名
1、 程叙文件(*.cs)中的变量命名
程序中变量名称 = 变量的前缀 +代表变量含意的英文单词或者单词缩写。
类模块级的变量请用“m_”  +数据类型缩写作为前缀(其中，  m 为 “module”缩写，数据类型缩写见附件中的《数据类型缩写表》)。
publicclassHello
{
privatestring m_strName;
privateDataTable m_dtblTable;
}
类的属性所对应的变量，采用属性名前加“m_”+ 类型缩写 前缀的形式
publicclassHello
{
privatestring m_strName;
privateDataTable m_dtblTable;