C#.NET编程规约

《C#.NET编程规约》由会员上传分享，免费在线阅读，更多相关内容在教育资源-天天文库。

1、社内C#.NetET编程规约1概述1.1规范制定原则1方便代码的交流和维护。2不影响编码的效率，不与大众习惯冲突。3使代码更美观、阅读更方便。4使代码的逻辑更清晰、更易于理解。1.2术语定义1.2.1Pascal大小写Pascal大小写形式是指名称中单词的第一个字母大写，如：EmployeeSalary,ConfirmDialog。1.2.2Camel大小写这种形式类似于Pascal大小写形式，但名称中第一个单词的第一个字母不是大写：employeeSalary,comfirmDialog。2命名对于理解应用程序的逻辑流，命名方案是最有影响力的一种帮助。名称应该说明“什么”而不是“如

2、何”。通过避免使用公开基础实现（它们会发生改变）的名称，可以保留简化复杂性的抽象层。例如，可以使用GetNextStudent()，而不是GetNextArrayElement()。2.1命名原则选择正确名称时的困难可能表明需要进一步分析或定义项的目的。使名称足够长以便有一定的意义，并且足够短以避免冗长。唯一名称在编程上仅用于将各项区分开。表现力强的名称是为了帮助人们阅读；因此，提供人们可以理解的名称是有意义的。不过，请确保选择的名称符合适用语言的规则和标准。最好不要使用带有下划线的单词。使用全称避免缩写，除非缩写已是一种公认的约定，如URL、HTML。1.1命名大小写原则在名称的大

3、小写方面，名称大部分都应采用Pascal大小写命名形式。其中，命名空间、类、以及基类中的成员、接口、属性、方法、事件、静态字段等的名称都应遵循该规则。对于常量的定义采用全部大写的原则。此外还推荐使用另一种大小写模式：camel大小写形式。有两种情况建议使用camel大小写形式。1传递给方法的所有参数都应是camel大小写形式：PublicvoidRecordSale(intemployeeSalary,intquanitity);2camel大小写形式也可以用于区分同名的两个对象—比较常见的情况是属性封装一个字段：PrivatestringemployeeName;Publicstr

4、ingEmployeeName{Get{ReturnemployeeName;}}1.2命名空间命名空间（namespace）的名称非常重要，需要仔细设计，以避免一个命名空间中对象的名称与其他对象同名。命名空间的名称是.Net区分共享装配件中对象名的唯一方式，如果软件包的命名空间使用的名称与另一个软件包相同，而这两个软件包都安装到一台计算机上，就会出问题。因此，命名空间的名称最好用本公司名创建顶级的命名空间，再嵌套客户所在公司、或产品类所在软件包的命名空间,继而嵌套软件中所在模块层次名字的命名空间。例如Pcguandian，DataAccess。这样的命名空间就肯定是安全的，不会与其

5、他人编写的命名空间同名。1.3变量1.3.1变量前缀C#的约定是命名变量时不使用任何前缀：stringResult;stringMessage。1.3.2杂项a)在变量名中使用互补对，如min/max、begin/end和open/closeb)布尔变量名应该包含Is，这意味着Yes/No或True/False值，如fileIsFoundc)即使对于可能仅出现在几个代码行中的生存期很短的变量，仍然使用有意义的名称。仅对于短循环索引使用单字母变量名，如i或ja)不要使用原义数字或原义字符串，如Fori=1To7。而是使用命名常数，如Fori=1ToNUM_DAYS_IN_WEEK以便于

6、维护和理解1.1控件1.1.1命名方法和社内其他编程工具开发规约类似，控件命名采用控件名简写+英文描述的方式，其中英文描述首字母大写1.1.2主要控件名简写对照表控件名简写LabellblTextBoxtxtButtonbtnLinkButtonlnkbtnImageButtonimgbtnDropDownListddlListBoxlstDataGriddgDataListdlCheckBoxchkCheckBoxListchklsRadioButtonrdoRadioButtonListrdoltImageimgPanelpnlCalendercldAdRotatorarTabl

7、etblRequiredFieldValidatorrfvCompareValidatorcvRangeValidatorrvRegularExpressionValidatorrevValidatorSummaryvsCrystalReportViewerrptvew1.2类a)用名词或名词短语命名类似b)不要使用类型前缀，如在类名称上对类使用C前缀。例如，使用类名称FileStream，而不是CFileStreama)有时候需要提供以字母I开始的类名称