《C#编码规范》.docVIP

C#编码规范第 PAGE 9/ NUMPAGES 10页 长江大学计算机学院HYPERLINK 程序结构 所有源代码的结构均采用以下顺序布局，对于没有的部分可以省略，便于阅读代码。 //============================================================================================== #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 //============================================================================================== 命名规则和风格 ⑴ 类、方法、常量采用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命名空间中的别名 例如：采用object不用Object 采用string不用String 采用int不用Int32 ⑾ 对于泛型类型采用大写字母。当处理.NET类型的Type时保留其后缀Type // 正确方法： public class LinkedListK,T {……} // 避免使用： ????public class LinkedListKeyType,DataType {……} ⑿ 采用有意义的命名空间名，例如产品名称或公司名称 ⒀ 避免使用类的全称，而是采用using声明 ⒁ 避免在命名空间内使用using语句 ⒂ 把所有系统框架提供的名称空间组织到一起，把第三方提供的名