项目编码规范

项目开发规则

C#命名规范

1.1命名空间

框架中所有命名空间的起始部分COM.ACCP

业务中所有命名空间的起始部分COM.ASSEMBLY.FOLDER

实际结构和名称以业务为准

1.2类

1)名字应该能够标识事物的特性。

2)名字可以有两个或三个单词组成，但通常不应多于三个。

3)采用Pascal case，所有单词第一个字母大写。

4)使用名词或名词短语命名类。

5)少用缩写。

6)不要使用下划线字符(_)。

例：

public class FileStream

public class Button

1.3接口

和类命名规范相同，唯一区别是接口在名字前加上“I”前缀

例：

interface IDBCommand

interface IButton

1.4枚举

和类命名规范相同，唯一区别是枚举在名字前加上“E”前缀

例：

enum ESystemType

1.5方法

1)使用动词或动词短语命名方法。

2)采用Pascal case，所有单词第一个字母大写。

3)方法中的参数命名采用Camel casing,所有单词第一个字母大写，除了首字母小写。

1.6属性

1)使用名词或名词短语命名

2)采用Pascal case，所有单词第一个字母大写

3)少用缩写

4)不要使用下划线字符( _ )

1.7变量

1)变量名称= 变量的前缀+ 代表变量含意的英文单词或单词缩写。

常用变量类型的前缀命名规则，定义如下：

常用对象:

2)类的私有变量，在遵循第一条规则后，在其前加“m_”前缀。

例:

public class Hello

{

private string m_strName;

public string Name

{

get

{

return m_strName;

}

}

}

3)即使对于可能仅出现在几个代码行中的生存期很短的变量，仍然使用有意义的名称。

仅对于短循环索引使用单字母变量名，如i或j。

4)不要使用原义数字或原义字符串，如for(int i = 1;i <= 7;i++)。而是使用命名

常数，如for(int i = 1;i <= NUM_DAYS_IN_WEEK;i++)以便于维护和理解。

1.8常量

1)常量的名字应该都大写，并且指出完整含义，单词之间用下划线（_）分隔。

例：

const int PAGE_COUNT = 10;

1.9控件

前台系统开发时，只能使用下面列出的控件，又不能满足要求请先和模块负责人联系。讨论通过后才可使用，规范修改前严禁使用未列出的控件。Framework有提供相应控件的，不得使用.Net标准控件

控件命名= Window控件缩写前缀 + 变量名

1.10数据集命名规范

1)普通数据集命名以Ds开头

2)作为查询参数的数据集命名以DsQuery开头，表名以QUERY_为前缀

3)元素的所有字母大写，各字母以下划线“_”分割

4)专用名词建议使用习惯缩写

5)与后台交互的数据集不允许使用属性

1.11注释

注释规范包括：类注释规范、类的属性、方法注释规范、代码间注释规范

1.11.1类注释规范

类开始必须以以下形式书写类注释：

///

///类的描述:

///作者：

///创建时间：<格式：YYYY-MM-DD>

///

1.11.2类属性注释规范

在类的属性必须以以下格式编写属性注释：

///

/// 属性说明:

///

1.11.3方法注释规范

在类的方法声明前必须以以下格式编写注释

///

/// 说明：<对该方法的说明>

///

/// <参数说明>

///

///<对方法返回值的说明>

///

1.11.4代码间注释规范

代码间注释分为单行注释和多行注释：单行注释：

//<单行注释>

多行注释：

/* 多行注释1

多行注释2

多行注释3

*/

2C#代码格式规范

1)所有的缩进为4个空格，使用https://www.360docs.net/doc/676295188.html,的默认设置。

2)在代码中垂直对齐左括号和右括号。(需讨论)

例：

if(x == 0)

{

Response.Write("用户编号必须输入！");

}

不允许以下情况：

if(x==0) {

Response.Write("用户编号必须输入！");

}

或者：

if(x==0){ Response.Write("用户编号必须输入！");}

3)为了防止在阅读代码时不得不滚动源代码编辑器，每行代码或注释在1024*800的显示

频率下不得超过一显示屏

4)每一行上放置的语句避免超过一条。

5)在大多数运算符之前和之后使用空格，这样做时不会改变代码的意图却可以使代码

容易阅读。

例：

int j = i + k;

而不应写为

int j=i+k;

6)将大的复杂代码节分为较小的、易于理解的模块。

7)相同功能的代码段用＃region折叠起来，在阅读时比较简洁和易于理解

例：

#region 代码段说明

#endregion

3SourceSafe使用规范

代码维护一律使用https://www.360docs.net/doc/676295188.html,内嵌的集成方式，不要使用VSS客户端工具（客户端工具仅用来维护文档版本）。

注意：必须安装https://www.360docs.net/doc/676295188.html,2003安装程序内带的VSS版本（6.0d），才能与https://www.360docs.net/doc/676295188.html,环境集成。

如果已安装其它早期版本，请先卸载再安装新版本。

3.1创建项目

第一个创建项目的人应在https://www.360docs.net/doc/676295188.html,2003环境下的菜单中选择“文件”—〉“源代码管理器”—〉“将选定项目添加到源代码管理器”（注意：不要选择“将解决方案添加到源代码管理器”）。

下图是一个Project的资源管理视图，其中bin、obj两个灰色的目录是https://www.360docs.net/doc/676295188.html,2003自动生成的临时文件夹，用来保存编译过程中的临时文件，不应上传到SourceSafe上，否则会因为指读属性影响本地编译结果。

其它灰色的文件都是指project之外的文件，均不应该上传至Sourcesafe。

3.2获取项目

其他开发人员需要使用项目文件时，必须在https://www.360docs.net/doc/676295188.html,2003环境下的菜单选择文件->源代码管理->从源代码管理打开…

3.3日常使用规范

1. 项目文件(*.csproj)签出后应当尽早签入，以避免影响其他人使用。

2. 签入前必须先编译通过，编译通过后的文件允许签入

3．相关文件必须一次性签入，推荐整个项目一次性整体签入

4．每日下班前，必须签入编译通过的版本。

总则：不管你用什么命名方法，所有的命名规则一定要统一，不要一会儿中文拼音一会儿英文等等。

1、采用英文单词或英文短语（包括缩写）作为名称，不能使用无意义的字符或汉语拼

音。

2、每个数据库对象表，视图，字段，存储过程，不要用任何数据库的关键词作为名称。凡是能写注释的地方，应该写上注释，以便查看。

3、名称应该清晰明了，能够准确表达事物的含义，最好可读，遵循“见名知意”的原则。

4、对长度也要有限制，最好不要超过30个字符，在PD设置生成时，部分数据库对象会自动截取到30位。

5、所有名称的字符范围为：A-Z, a-z, 0-9 和_(下划线)。不允许使用其他字符作为名称。

6、注释分单行和双行，在数据库对象如函数，存储过程，视图等，都需要在页头添加