代码书写规范(C#NET).doc

PAGE1/NUMPAGES1

代码书写规范(C#NET)

代码书写规范(C#.NET)Version:1.0目录目录类书写标准(C#.NET)1目录11目的22编码规范22.1代码格式22.2顶部声明内容32.3方法位置32.4#Region使用错误！未定义书签。

3注释规范43.1模块（类）注释规范43.2类属性注释规范53.3方法注释规范53.4代码间注释规范54命名规范64.1类命名规范64.2成员变量64.3局部变量64.4资源命名64.5其他命名64.6命名注意75.模板类71编写目的为了保证编写出的程序都符合相同的规范，保证一致性、统一性而建立的程序编码规范。

编码规范对于程序员而言尤为重要，有以下几个原因：

1.一个软件的生命周期中，80%的花费在于维护。

2.几乎没有任何一个软件，在其整个生命周期中，均由最初的开发人员来维护。

3.编码规范可以改善软件的可读性，可以让程序员尽快而彻底地理解新的代码。

为了执行规范，每个软件开发人员必须一致遵守编码规范！2目录结构规范(1)目录建立的原则：

以最少的层次提供最清晰简便的访问结构。

(2)目录的命名以小写英文字母，下划线组成。

(参照命名规范)。

(3)根目录一般只存放index.htm以及其他必须的系统文件；每个主要栏目开设一个相应的独立目录；根目录下的images用于存放各页面都要使用的公用图片，子目录下的images目录存放本栏目页面使用的私有图片。

(4)所有JS,ASP,PHP等脚本存放在根目录下的scripts目录。

(5)所有CGI程序存放在根目录下的cgi-bin目录。

(6)所有CSS文件存放在根目录下style目录。

(7)每个语言版本存放于独立的目录。

例如：

简体中文gb；(8)所有flash,avi,ram,quicktime等多媒体文件存放在根目录下的media目录。

3编码规范3.1代码格式所有的缩进以Tab代替空格。

Region表示相关的内容，避免分类过细，请按照前一部分列出的进行分类。

函数内部或者类的内部，可以嵌套region使用。

尽可能的使用此标签折叠相关内容。

折叠的好处是我们可能打开某个部分。

先看到每个region，对程序有个认识，然后根据需要展开具体的块。

如果需要全部展开，可以使用快捷键：

ctrl+m,ctrl+o。

在代码中垂直对齐左括号{和右括号}。

if(x==0){Response.Write(用户编号必须输入！);}不允许以下情况：

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

if(x==0){Response.Write(用户编号必须输入！);}这样更容易阅读和修改语句。

3.2顶部声明内容文件的顶部可以包含文件的测试数据、注释、作者、创建时间、修改人、修改时间。

但不强行规定。

但涉及到数据的，需要包含测试数据。

注释以//的方式添加多个单行注释。

/************空气环境监测信息管理__数据业务逻辑层************///描述：

滁州市环境地理信息系统//功能：

三层架构中数据层业务实体//开发者：

滁州学院***//开发时间:2010.12.12/************空气环境监测信息管理__数据业务逻辑层************/3.3方法位置方法需要将相关的内容归类在一起。

我们分为下面几个部分：

delegateandsubtype，field，property，ctor,init,dtor，method，function这里6个部分表示了一个类最复杂情况所包含的内容。

把相关内容放在一起也利于我们自己查找和维护。

下面介绍一下每个部分应该书写什么内