C软件开发编码规范.docVIP

类书写标准(C#/VB.NET) Ver:1.1 顶部声明内容 2 方法位置 3 #Region使用 5 变量初始值 6 变量命名 7 顶部声明内容 文件的顶部可以包含文件的测试数据、注释、作者、创建时间、修改人、修改时间。但不强行规定。但涉及到数据的，需要包含测试数据。注释以//的方式添加多个单行注释。 //作者 ：吴亚喆(wyz) //创建时间 ：2008-8-14 //修改人 ：吴亚喆 //修改时间 ：2008-8-15 //功能 ：消息管理器方法位置 方法需要将相关的内容归类在一起。我们分为下面几个部分： delegate and subtype field property ctor,init,dtor method function 这里6个部分表示了一个类最复杂情况所包含的内容。把相关内容放在一起也利于我们自己查找和维护。下面介绍一下每个部分应该书写什么内容。 delegate and subtype 类中用到的委托，或者子类型的声明，子类型不要声明为平级，而是声明为包含的类。 field 成员变量，尽量的都声明为私有，事件声明为其他访问级别。 property 属性书写在这里，属性的访问器get和set的访问级别可以不一样，例如 public int IntProperty { public get { return intVar; } internal set { intVar = value; } } cotor,init,dtor 构造函数，初始化和释放。 如果是窗体，对应的OnLoad,OnHandleCreate,OnActive的方法，Form1_Load,Form1_Active的事件响应方法应当卸载这里。 如果是控件，对应的OnLoad,OnHandleCreate,OnActive,OnParentChanged的方法应当写在这里。 如果是一般的类，Dispose接口的实现，析构函数，释放函数都应当写在这里。 method 书写类对外的主要接口方法，例如Open,Close,Write,Read之类，对象直接的抽象。 function 书写可能重复的方法，例如多个Open方法都要做CheckOpenStatus，这个操作用户不会直接使用，或者不常用，则写在这里。 模板类： /* 注意事项： */ using System; using System.Collections.Generic; using System.Text; namespace ZHD { public class Class1 { #region delegate and subtype #endregion #region field #endregion #region ctor,init,dtor public Class1() { } #endregion #region property #endregion #region method #endregion #region function #endregion } }#Region使用 Region表示相关的内容，避免分类过细，请按照前一部分列出的进行分类。函数内部或者类的内部，可以嵌套region使用。尽可能的使用此标签折叠相关内容。折叠的好处是我们可能打开某个部分。先看到每个region，对程序有个认识，然后根据需要展开具体的块。如果需要全部展开，可以使用快捷键：ctrl+m,ctrl+o。变量初始值 变量分2种，类成员变量和方法的局部变量。 成员变量： 尽可能的在声明处初始化，但不要进行多余的初始化，例如对数值类型变量赋值为0，对引用类型变量赋值为null。这样会多一条IL的汇编语句，并不会带来实际意义。对于需要在运行时构造的，编写构造函数，并在多个构造函数的情况下，通过调用来初始化，不要赋值代码。 局部变量： 主动释放自己分配的非托管资源。 变量命名 类型的缩写+功能，例如，创建一个窗体，就起名为：frmRoad。frm为前缀，form的缩写，Road是功能，第一个字母小写，好处是frm小写，人们注意力首先会看到大写字母，能看到功能描述的单词，然后才关注frm。突出重点。也能从变量名知道是什么类型的。 类名的命名： 窗体。控件类，需要在前面写类型，例如：frmRoad,ctlSurveyComputer。 功能形类，无特殊要求，