c#开发规范.doc

C# 编程规范 01 概述规范制定原则 1、方便代码的交流和维护。 2、不影响编码的效率,不与大众习惯冲突。 3、使代码更美观、阅读更方便。 4、使代码的逻辑更清晰、更易于理解。术语定义 Pascal 大小写每个单词的第一个字母都大写。例: BackColor Camel 大小写除第一个字母外,其它都将第一个字母大写。例如: backColor 02 命名规范命名概述命名原则: 1、选择正确名称时的困难可能表明需要进一步分析或定义项的目的。 2、使名称足够长以便有一定的意义,并且足够短以避免冗长。 3、表现力强的名称是为了帮助人们阅读,提供人们可以理解的名称是有意义的。注意事项: 1、避免容易被误解或难懂的命名,如: AnalyzeThis() ,或者属性名 xxK8 。 2、类属性的名称中包含类名是多余的,如 。而是应该使用 。 3、只要合适,在变量名的末尾或开头加计算限定符( Avg 、 Sum 、 Min 、 Max 、 Index )。 4、变量名中使用互补对,如 min/max 、 begin/end 和 open/close 。 5、布尔变量名应该包含 Is,这意味着 Yes/No 或 True/False 值,如 Is File Found 。 6、命名状态变量时,避免使用诸如 Flag 的术语。状态变量不同于布尔变量的地方是它可以具有两个以上的可能值。不是使用 documentFlag ,而是使用更具描述性的名称,如 documentFormatType 。(此项只供参考) 7、即使对于可能仅出现在几个代码行中的生存期很短的变量,仍然使用有意义的名称。仅对于短循环索引使用单字母变量名,如 i或j。 8、要避免硬编码,如 f ori=1 To7。而是使用命名常数,如 For i=1 To NUM_DAYS_IN_WEEK 以便于维护和理解。 9、不要对字段名使用匈牙利语表示法。例: int intMax = 0; 10、不要对字段名或静态字段名应用前缀。例如,应用 g_或 s_前缀是不正确的。 11、 的关键字重复。大小写规则规则说明举例全大写由两个或者更少字母组成的标识符 System. IO . UI 常量 const int PIE = ; 枚举类型及枚举值 enum COLOR {RED, BLUE, GREEN}; 大写开头 public 及 internal 类型及 public int GetMoney(); 文件名 类名 class PatientEventArgs : EventArgs 小写开头 private 类型 private int getMoney(); 参数 string Format(string format, args() As object) _开头 P rotect 类型 protect int _age; 备注:全大写的多个单词之间用"_" 隔开。缩写 1在适当的时候,使用众所周知的缩写替换冗长的词组名称。例如,用 UI作为 User Interface 缩写,用 OLAP 作为 On-line Analytical Processing 的缩写。 2在使用缩写时,对于超过两个字符长度的缩写请使用 Pascal 大小写或 Camel 大小写。例如,使用 HtmlButton 或 HTMLButton 。但是,应当大写仅有两个字符的缩写,如, ,而不是 。命名空间 1、命名命名空间时的一般性规则是使用公司名称,后跟项目名称和可选的功能与设计。 CompanyName. Project Name[. Module ][.Design] 例如: //中兴通公司的护理系统 //中兴通公司的护理系统的统计模块 2、命名空间使用 Pascal 大小写,用点号分隔开。类 1、一个类一个文件 2、类名与文件名要匹配 3、用名词或名词短语命名类。 4、不要使用类型前缀,如在类名称上对类使用 C前缀。如,类名称 FileStream ,而不是 CFileStream 。 5、有时候需要提供以字母 I开始的类名称,虽然该类不是接口。只要 I是作为类名称组成部分的整个单词的第一个字母,这便是适当的。例如,类名称 IdentityStore 是适当的。 6、在适当的地方,使用复合单词命名派生的类。派生类名称的第二个部分应当是基类的名称。例如, ApplicationException 对于从名为 Exception 的类派生的类是适当的名称,原因 Ap