C#编码规范(完整资料).doc

【最新整理，下载后即可编辑】

1程序结构

所有源代码的结构均采用以下顺序布局，对于没有的部分可以省略，便于阅读代码。

//============================================== ================================================ #region Constant

#endregion Constant

//----------------------------------------------------------------------------------------------

#region Members

#endregion Members

//----------------------------------------------------------------------------------------------

#region Defaults

#endregion Defaults

//----------------------------------------------------------------------------------------------

#region Properties

#endregion Properties

//============================================== ================================================ #region Constructors

#endregion Constructors

//----------------------------------------------------------------------------------------------

#region InterfaceMethods

#endregion InterfaceMethods

//----------------------------------------------------------------------------------------------

#region StaticMethods

#endregion StaticMethods

//----------------------------------------------------------------------------------------------

#region OverrideMethods

#endregion OverrideMethods

//----------------------------------------------------------------------------------------------

#region PrivateMethods

#endregion PrivateMethods

//----------------------------------------------------------------------------------------------

#region ProtectedMethods

#endregion ProtectedMethods

//----------------------------------------------------------------------------------------------

#region PublicMethods

#endregion PublicMethods

//============================================== ================================================ #region Events

#endregion Events

//============================================== ================================================ 2命名规则和风格

⑴类、方法、常量采用Pascal风格命名

public class SomeClass

{

const int DefaultSize = 100;

public SomeMethod()

{

}

}

⑵成员变量采用Camel风格命名，但前面加一个底划线

public class SomeClass

{

int _port = 5000;

public SomeMethod()

{

}

}

⑶局部变量和方法参数采用Camel风格命名

public class SomeClass

{

public SomeMethod(int len)

{

string sLine;

}

}

⑷接口采用I作为前缀命名

interface IMyInterface

{

}

⑸自定义属性类型以Attr作为后缀命名

⑹自定义异常类型以Ex作为后缀命名

⑺采用动名词命名方法，例如ShowDialog()

⑻有返回值的方法的命名应该能够描述其返回值，例如GetObjectState()

⑼采用描述性的变量名。

a) 避免采用单字母的变量名，如i或t；而是采用index或temp

b) 对public和protected成员避免采用用匈牙利命名法，如：采用Port不用nPort，

c) 尽量不要采用缩写（例如将number缩写为num）

⑽总是使用C#预定义的类型，而不是使用System命名空间中的别名