C#项目命名要求规范范例.docx

1、C#项目命名要求规范范例 C#项目开发代码规X命名规X制定意义 1 方便代码的交流和维护，便于日后自己的再次阅读。 2 不影响编码的效率，不与大众习惯冲突。 3 使代码更美观、阅读更方便。 4 使代码的逻辑更清晰、更易于理解命名规X制定原如此首要原如此有意义的，描述性的词语来命名。能够一眼看出它作什么。别使用会引起误解的名字。如果名字一目了然，就无需用文档来解释方法的功能了1.除约定俗成的，别用缩写。用name, address, salary等代替 nam, addr, sal 2.除用于循环，别使用单个字母的变量象i, n, x 等. 而要使用 index, temp等。for ( int

2、 i = 0; i count; i+ ) .其他习惯 除了界面控件外，不要使用类型前缀。比如：使用名称amount，而不是 intAmount； 类：使用名词、名词短语命名。比如：public class FileStream； 方法：使用动词、动词短语开始。比如：CreateUser(), RemoveAt()等； 接口：以 I 开始，后面加上名词、名词短语、形容词命名。比如：IDisposable； 常量：所有单词大写，多个单词之间用 _ 隔开。public const string PAGE_TITLE = Wele; 命名空间：根本格式：panyName/ProjectName.Te

3、chnologyName.Feature.Designa) panyName/ProjectName：公司名、项目名称或产品名称；b)TechnologyName：稳定的、公认的技术名称或架构层次名称；c).Feature.Design：可选的功能与设计；变量方法命名规如此C#命名规X1、用pascal规如此来命名方法和类.(第一个单词首字母大写，后面连接的每个单词首字母都大写publicclassDataBase；publicvoidGetDataTable()2、类：使用名词、名词短语命名。比如：public class FileStream；2.用camel规如此来命名局部变量和方法的参

4、数.(第一个单词不大写，后面连接的单词首字母大写)publicvoidAddUser(stringuserId,bytepassword)stringuserName;3.所有的成员变量前加前缀_publicclassDatabaseprivatestring_connectionString;4.接口的名称加前缀IinterfaceIpareintpare();5.自定义代码属性类以Attribute结尾publicclassOperationAttribute:Attribute6.自定义的异常以Exception结尾publicclassAppException:Exception7.方

5、法的命名.一般将其命名为动宾短语，“动词对象.GetRecordData();GetPath();CreateFile();8.代码的缩进.要用Tab，而不要用space. 9. 使用带有说明性的变量名。防止单字符串的变量名，使用类似于index或temp这样有意义的名字。对于public或protected类型的变量防止使用匈牙利表示法。不要缩写单词。10. 所有的类成员变量应该被声明在类的顶部，并用一个空行把它们和方法以与属性的声明区分开.11.用有意义的名字命名namespace，如：产品名、公司名.12.建议局部变量在最接近使用它时再声明.13.使用某个控件的值时，尽量命名局部变量.1

6、4.把引用的系统的namespace和自定义或第三方的用一个换行把它们分开.15.文件名要能反响类的内容，最好是和类同名，一个文件中一个类或一组关连类.16.目录结构中要反响出namespace的层次.17.大括号要新起一行. 18.在和你的代码缩进处于同一个级别处为该行代码添加注释19单独方法要加注释 字段一目了然的课一部详细说名例如：/ / / / / public string GetNameint idreturn “xiaomi“；名称应该说明“什么而不是“如何。通过防止使用公开根底实现它们会发生改变的名称，可以保存简化复杂性的抽象层。例如，可以使用 GetNextStudent()

7、，而不是 GetNextArrayElement()。 命名原如此是：选择正确名称时的困难可能明确需要进一步分析或定义项的目的。使名称足够长以便有一定的意义，并且足够短以防止冗长。唯一名称在编程上仅用于将各项区分开。表现力强的名称是为了帮助人们阅读；因此，提供人们可以理解的名称是有意义的。不过，请确保选择的名称符适宜用语言的规如此和标准。以下几点是推荐的命名方法。1、防止容易被主观解释的难懂的名称，如方面名 AnalyzeThis()，或者属性名 xxK8。这样的名称会导致多义性。2、在类属性的名称中包含类名是多余的，如 。而是应该使用 。3、只要适宜，在变量名的末尾或开头加计算限定符Avg、

8、Sum、Min、Max、Index。4、在变量名中使用互补对，如 min/max、begin/end 和 open/close。 5、布尔变量名应该包含 Is，这意味着 Yes/No 或 True/False 值，如 fileIsFound。6、在命名状态变量时，防止使用诸如 Flag 的术语。状态变量不同于布尔变量的地方是它可以具有两个以上的可能值。不是使用 documentFlag，而是使用更具描述性的名称，如 documentFormatType。 此项只供参考7、即使对于可能仅出现在几个代码行中的生存期很短的变量，仍然使用有意义的名称。仅对于短循环索引使用单字母变量名，如 i 或 j。

9、 可能的情况下，尽量不要使用原义数字或原义字符串，如For i = 1 To 7。而是使用命名常数，如 For i = 1 To NUM_DAYS_IN_WEEK 以便于维护和理解。8、用于事件处理的委托添加“EventHandler后缀9、用于事件处理之外的那些委托添加“Callback后缀10、不要给委托添加“Delegate后缀11、用名词或名词词组来给类型命名，在少数情况下也可以用形容词词组来给类型命名12、用动词或动词词组来命名方法13、用名词、名词词组或形容词来命名属性14、要用动词或动词短语来命名事件15、要用名词或名词短语来命名字段 小写规如此大写标识符中的所有字母都大写。仅对

10、于由两个或者更少字母组成的标识符使用该约定。例如：下表汇总了大写规如此，并提供了不同类型的标识符的示例。标识符大小写样例名字空间Pascalnamespace 类型Pascalpublic class StreamReader 接口Pascalpublic interface IEnumerable 方法Pascalpublic class Object public virtual string ToString();属性Pascalpublic class String public int Length get; 事件Pascalpublic class Processpublic ev

11、ent EventHandler Exited;字段(私有实例)Camelprivate string userName；字段(公共静态)Pascalpublic static readonly string UserId;枚举Pascalenum FileMode Append, 参数Camelpublic class Convert public static int ToInt32(string userId);缩写为了防止混淆和保证跨语言交互操作，请遵循有关区缩写的使用的如下规如此： 1 不要将缩写或缩略形式用作标识符名称的组成局部。例如，使用 GetWindow，而不要使用 GetW

12、in。 2 不要使用计算机领域中未被普遍承受的缩写。 3 在适当的时候，使用众所周知的缩写替换冗长的词组名称。例如，用 UI 作为 User Interface 缩写，用 OLAP 作为 On-line Analytical Processing 的缩写。 4在使用缩写时，对于超过两个字符长度的缩写请使用 Pascal 大小写或 Camel 大小写。例如，使用 HtmlButton 或 HTMLButton。但是，应当大写仅有两个字符的缩写，如，System.IO，而不是 System.Io。5 不要在标识符或参数名称中使用缩写。如果必须使用缩写，对于由多于两个字符所组成的缩写请使用Camel

13、 大小写，虽然这和单词的标准缩写相冲突。命名空间1、给命名空间命名时的一般性规如此是使用公司名称，后跟技术名称和可选的功能与设计，如下所示。panyName.TechnologyName.Feature.Design例如：namespace JadeBird.StudentManager/学员系统namespace JadeBird.StudentManager.Register /北学员注册模块 2、命名空间使用Pascal大小写，用点号分隔。3、TechnologyName 指的是该项目的英文缩写，或软件名。4、命名空间和类不能使用同样的名字。例如，有一个类被命名为Debug后，就不要再使

14、用Debug作为一个名称空间名。文件命名1 文件名遵从Pascal命名法，无特殊情况，扩展名小写。类1、使用 Pascal 大小写。2、用名词或名词短语命名类。3、使用全称防止缩写，除非缩写已是一种公认的约定，如URL、HTML4 、不要使用类型前缀，如在类名称上对类使用 C 前缀。例如，使用类名称 FileStream，而不是CFileStream。5 、不要使用下划线字符 (_)。6 、有时候需要提供以字母 I 开始的类名称，虽然该类不是接口。只要 I 是作为类名称组成局部的整个单词的第一个字母，这便是适当的。例如，类名称 IdentityStore 是适当的。在适当的地方，使用复合单词命

15、名派生的类。派生类名称的第二个局部应当是基类的名称。例如，ApplicationException 对于从名为 Exception 的类派生的类是适当的名称，原因ApplicationException 是一种Exception。请在应用该规如此时进展合理的判断。例如，Button 对于从 Control 派生的类是适当的名称。尽管按钮是一种控件，但是将 Control 作为类名称的一局部将使名称不必要地加长。publicclassFileStreampublicclassButtonpublicclassString接口以下规如此概述接口的命名指南： 1、用名词或名词短语，或者描述行为的形容

16、词命名接口。例如，接口名称 Iponent 使用描述性名词。接口名称 ICustomAttributeProvider 使用名词短语。名称 IPersistable 使用形容词。 2、使用 Pascal 大小写。 3、少用缩写。4、给接口名称加上字母 I 前缀，以指示该类型为接口。在定义类/接口对其中类是接口的标准实现时使用相似的名称。两个名称的区别应该只是接口名称上有字母 I 前缀。 5、不要使用下划线字符 (_)。 6、当类是接口的标准执行时，定义这一对类/接口组合就要使用相似的名称。两个名称的不同之处只是接口名前有一个I前缀。以下是正确命名的接口的示例。 public interface

17、 IServiceProvider public interface IFormatable以下代码示例阐释如何定义 Iponent 接口与其标准实现 ponent 类。publicinterfaceIponent/Implementationcodegoeshere.publicclassponent:Iponent/Implementationcodegoeshere.枚举 (Enum)枚举 (Enum) 值类型从 Enum 类继承。以下规如此概述枚举的命名指南： 1 对于 Enum 类型和值名称使用 Pascal 大小写。 2 少用缩写。 3 不要在 Enum 类型名称上使用 Enum

18、后缀。 4 对大多数 Enum 类型使用单数名称，但是对作为位域的 Enum 类型使用复数名称。 5 总是将 FlagsAttribute 添加到位域 Enum 类型。6不要命名“Reserved枚举值。参数以下规如此概述参数的命名指南： 1、使用描述性参数名称。参数名称应当具有足够的描述性，以便参数的名称与其类型可用于在大多数情况下确定它的含义。 2、对参数名称使用 Camel 大小写。 3、 使用描述参数的含义的名称，而不要使用描述参数的类型的名称。开发工具将提供有关参数的类型的有意义的信息。因此，通过描述意义，可以更好地使用参数的名称。少用基于类型的参数名称，仅在适合使用它们的地方使用它

19、们。 4、不要使用保存的参数。保存的参数是专用参数，如果需要，可以在未来的版本中公开它们。相反，如果在类库的未来版本中需要更多的数据，请为方法添加新的重载。 5、不要给参数名称加匈牙利语类型表示法的前缀。以下是正确命名的参数的示例。Type GetType(string typeName)string Format(string format, args() As object) 方法以下规如此概述方法的命名指南： 1 使用动词或动词短语命名方法。 2 使用 Pascal 大小写。 3 以下是正确命名的方法的实例。 RemoveAll() GetCharArray() Invoke()11属性

20、 (property)以下规如此概述属性的命名指南： 1 使用名词或名词短语命名属性。 2 使用 Pascal 大小写。 3 不要使用匈牙利语表示法。 4 考虑用与属性的根底类型一样的名称创建属性。例如，如果声明名为 Color 的属性，如此属性的类型同样应该是 Color。请参阅本主题中后面的示例。 以下代码示例阐释正确的属性命名。publicclassSampleClasspublicColorBackColor/CodeforGetandSetaccessorsgoeshere.以下代码示例阐释提供其名称与类型一样的属性。publicenumColor/InsertcodeforEnum

21、here.publicclassControlpublicColorColorget/Insertcodehere.set/Insertcodehere. 以下代码示例不正确，原因是 Color 属性是 Int 类型的。public enum Color/ Insert code for Enum here. public class Control public int Color / Insert code here 在不正确的示例中，不可能引用 Color 枚举的成员。Color.Xxx 将被解释为访问一个成员，该成员首先获取 Color 属性 C# 中为 int 类型的值，然后再访问该

22、值的某个成员该成员必须是 System.Int32 的实例成员。12事件以下规如此概述事件的命名指南： 1、对事件处理程序名称使用 EventHandler 后缀。 2、指定两个名为 sender 和 e 的参数。sender 参数表示引发事件的对象。sender 参始终是object 类型的，即使在可以使用更为特定的类型时也如此。与事件相关联的状态封装在名为 e 的事件类的实例中。对 e 参数类型使用适当而特定的事件类。 3、用 EventArgs 后缀命名事件参数类。 4、考虑用动词命名事件。 5、使用动名词动词的“ing形式创建表示事件前的概念的事件名称，用过去式表示事件后。例如，可以取

23、消的 Close 事件应当具有 Closing 事件和 Closed 事件。不要使用BeforeXxx/AfterXxx 命名模式。 6、不要在类型的事件声明上使用前缀或者后缀。例如，使用 Close，而不要使用 OnClose。 7、通常情况下，对于可以在派生类中重写的事件，应在类型上提供一个受保护的方法称为 OnXxx。此方法只应具有事件参数 e，因为发送方总是类型的实例。 以下示例阐释具有适当名称和参数的事件处理程序。public delegate void MouseEventHandler(object sender, MouseEventArgs e); 以下示例阐释正确命名的事件

24、参数类。public class MouseEventArgs : EventArgs int x;int y;public MouseEventArgs(int x, int y) this.x = x;this.y = y; public int Xgetreturn x; public int Ygetreturn y; 常量 (const)以下规如此概述常量的命名指南： 所有单词大写，多个单词之间用 _ 隔开。 如public const string PAGE_TITLE = Wele; 字段以下规如此概述字段的命名指南： 1、private、protected 使用 Camel 大

25、小写。2、public 使用 Pascal 大小写。3、拼写出字段名称中使用的所有单词。仅在开发人员一般都能理解时使用缩写。字段名称不要使用大写字母。下面是正确命名的字段的示例。 class SampleClass string url;string destinationUrl;4、不要对字段名使用匈牙利语表示法。好的名称描述语义，而非类型。 5、不要对字段名或静态字段名应用前缀。具体说来，不要对字段名称应用前缀来区分静态和非静态字段。例如，应用 g_ 或 s_ 前缀是不正确的。 6、对预定义对象实例使用公共静态只读字段。如果存在对象的预定义实例，如此将它们声明为对象本身的公共静态只读字段。使用 Pascal 大小写，原因是字段是公共的。下面的代码示例阐释公共静态只读字段的正确使用。