c#开发命名规范.doc

C#开发命名规范1定义Pascal大写：一种大小写形式，所有单词第一个字母大写，其他字母小写。Camel大写：一种大小写形式，除了第一个单词，所有单词第一个字母大写，其他字母小写。例：HelloWorld（Pascal大写），helloWorld（Camel大写）。Camel大写主要用于变量命名规范，其他命名多用Pascal大写，例如：类名、文件名，等等。2规范命名的宗旨：见名思义。能够使查阅者看到名称就知道：类型、含义。例：接口名称以“I”开头，表示interface。缩进与间隔：使代码美观，易于理解。良好的编程习惯：保持严谨的逻辑，利于少走弯路。也是重构的思想。a)类的命名规范用名词或名词短语命名类。使用Pascal大写。减少类名中缩写的使用量。不要使用任何类前缀。不要使用带下划线的字符。下面是一些正确命名的类名的例子。publicclassFileStreampublicclassButtonPS：C+规范中在类名前加“C”，表示改名字为类名。b)接口的命名规范使用名词或名词短语，或者描述行为的形容词来命名接口。例如，IComponent（描述性名词），ICustomAttributeProvider（名词短语），和IPersistable（形容词）。使用Pascal大写。减少接口名中缩写的使用量。不要使用带下划线的字符。在接口名前加前缀I，以表示这个类型是一个接口。不要在类名前加上前缀C。偶尔情况下，需要在类名前加上I而并不表示它是一个接口。在这种情况下，只要I后面的字符是小写就可（例如，IdentityStore。）当类是接口的标准执行时，定义这一对类/接口组合就要使用相似的名称。两个名称的不同之处只是接口名前有一个I前缀。下面我们举个例子，来看看接口IComponent和它的标准执行，类Component。publicinterfaceIComponentpublicclassComponent:IComponentpublicinterfaceIServiceProviderpublicinterfaceIFormatablePS：接口的命名同类命名规范，仅加上以“I”前缀。c)方法命名规范用动词或动词短语命名方法。用下述范例所示的Pascal大写方式命名方法。RemoveAll()GetCharArray()Invoke()PS：方法即操作，动词也！d)属性命名规范用名词或名词短语命名属性。用Pascal大写命名属性。属性与类型要一样。PS：属性是C#中区别于其他语言中的一种元素，其结合访问器相当于JavaBean中get，set方法，又有区别；属性也不同于字段。e)变量命名规范变量和方法参数使用Camel大小写形式publicclassHelloWorldinttotalCount=0;voidSayHello(stringname)stringfullMessage=Hello+name;.不要使用匈牙利方法来命名变量。以前，多数程序员喜欢它把数据类型作为变量名的前缀而m_作为成员变量的前缀。例如：stringm_sName;intnAge;然而，这种方式在.NET编码规范中是不推荐的。所有变量都用camel大小写形式，而不是用数据类型和m_来作前缀。用有意义的，描述性的词语来命名变量。-别用缩写。用name,address,salary等代替nam,addr,sal-别使用单个字母的变量象i,n,x等.使用index,temp等-用于循环迭代的变量例外：for(inti=0;icount;i+).如果变量只用于迭代计数，没有在循环的其他地方出现，许多人还是喜欢用单个字母的变量(i)，而不是另外取名。-变量名中不使用下划线(_)。-命名空间需按照标准的模式命名。PS：C+中一直用匈牙利方法来命名变量，C#又有新的命名规范，随了！C#中也不习惯在名称中用“_”。f)文件名要和类名匹配例如，对于类HelloWorld,相应的文件名应为helloworld.cs(或,helloworld.vb)PS：同Java。g)缩进和间隔缩进用TAB，不用SPACES。注释需和代码对齐。花括弧()需和括号外的代码对齐。在一个类中，各个方法需用一空行，也只能是一行分开。花括弧需独立一行，而不象if,for等可以跟括号在同一行。好：if(.)/Dosomething不好：if(.)/Dosomething在每个运算符前后都空一格。好：if(showResult=true)for(inti=0;i10;i+)/不好：if(showResult=true)for(inti=0;i10;i+)/PS：.NET中花括弧独立一行，然后回车，比较好用_。每个运算符前后都空一格，原来只是在关系/逻辑运算符前后空格，以后改正_。h)良好的编程习惯避免使用大文件。如果一个文件里的代码超过300400行，必须考虑将代码分开到不同类中。避免写太长的方法。一个典型的方法代码在125行之间。如果一个方法发代码超过25行，应该考虑将其分解为不同的方法。方法名需能看出它作什么。别使用会引起误解的名字。如果名字一目了然，就无需用文档来解释方法的功能了（重构中一招）。好：voidSavePhoneNumber(stringphoneNumber)/Savethephonenumber.不好：/Thismethodwillsavethephonenumber.voidSaveData(stringphoneNumber)/Savethephonenumber.一个方法只完成一个任务。不要把多个任务组合到一个方法中，即使那些任务非常小。好：/Savetheaddress.SaveAddress(address);/Sendanemailtothesupervisortoinformthattheaddressisupdated.SendEmail(address,email);voidSaveAddress(stringaddress)/Savetheaddress./.voidSendEmail(stringaddress,stringemail)/Sendanemailtoinformthesupervisorthattheaddressischanged./.不好：/Saveaddressandsendanemailtothesupervisortoinformthattheaddressisupdated.SaveAddress(address,email);voidSaveAddress(stringaddress,stringemail)/Job1./Savetheaddress././Job2./Sendanemailtoinformthesupervisorthattheaddressischanged./.使用C#或VB.NET的特有类型，而不是System命名空间中定义的别名类型。好：intage;stringname;objectcontactInfo;不好：Int16age;Stringname;ObjectcontactInfo;别在程序中使用固定数值，用常量代替。别用字符串常数，用资源文件（这个要注意了，平时忽略了）。避免使用很多成员变量。声明局部变量，并传递给方法。不要在方法间共享成员变量。如果在几个方法间共享一个成员变量，那就很难知道是哪个方法在什么时候修改了它的值。必要时使用enum，别用数字或字符串来指示离散值（想到的好处：易读，可以少些注释了_）。好：enumMailTypeHtml,PlainText,AttachmentvoidSendMail(stringmessage,MailTypemailType)switch(mailType)caseMailType.Html:/Dosomethingbreak;caseMailType.PlainText:/Dosomethingbreak;caseMailType.Attachment:/Dosomethingbreak;default:/Dosomethingbreak;不好：voidSendMail(stringmessage,stringmailType)switch(mailType)caseHtml:/Dosomethingbreak;casePlainText:/Dosomethingbreak;caseAttachment:/Dosomethingbreak;default:/Dosomethingbreak;别把成员变量声明为public或protected。一般声明为private而使用public/protected的Properties.不在代码中使用具体的路径和驱动器名。使用相对路径，并使路径可编程。永远别设想你的代码是在“C:”盘运行。你不会知道，一些用户在网络或“Z:”盘运行程序。应用程序启动时作些“自检”并确保所需文件和附件在指定的位置。必要时检查数据库连接。出现任何问题给用户一个友好的提示。（值得借鉴）如果需要的配置文件找不到，应用程序需能自己创建使用默认值的一份。如果在配置文件中发现错误值，应用程序要抛出错误，给出提示消息告诉用户正确值。错误消息需能帮助用户解决问题。永远别用象应用程序出错,发现一个错误等错误消息。而应给出象更新数据库失败。请确保登陆id和密码正确。的具体消息。显示错误消息时，除了说哪里错了，还应提示用户如何解决问题。不要用象更新数据库失败。这样的，要提示用户怎么做：更新数据库失败。请确保登陆id和密码正确。显示给用户的消息要简短而友好。但要把所有可能的信息都记录下来，以助诊断问题。i)注释别每行代码，每个声明的变量都做注释。在需要的地方注释。可读性强的代码需要很少的注释。如果所有的变量和方法的命名都很有意义，会使代码可读性很强并无需太多注释。行数不多的注释会使代码看起来优雅。但如果代码不清晰，可读性差，那就糟糕。如果应为某种原因使用了复杂艰涩的原理，为程序配备良好的文档和重分的注释。j)异常处理不要“捕捉了异常却什么也不做“。如果隐藏了一个异常，你将永远不知道异常到底发生了没有。发生异常时，给出友好的消息给用户，但要精确记录错误的所有可能细节，包括发生的时间，和相关方法，类名等。别写太大的try-catch模块。如果需要，为每个执行的任务编写单独的try-catch模块。这将帮你找出哪一段代码产生异常，并给用户发出特定的错误消息如果应用程序需要，可以编写自己的异常类。自定义异常不应从基类SystemException派生，而要继承于.IApplicationException。好：voidReadFromFile(stringfileName)try/readfromfile.catch(FileIOExceptionex)/logerror./re-throwexceptiondependingonyourcase.throw;不好：voidReadFromFile(stringfileName)try/readfromfile.catch(Exceptionex)/Catchinggeneralexceptionisbad.wewillneverknowwhetherit/wasafileerrororsomeothererror./Hereyouarehidinganexception./Inthiscasenoonewilleverknowthatanexceptionhappened.return;SqlServer命名规范参考各种命名规范，我们统一使用命名规范如下：命名过程中如有现存的缩写，则使用该缩写，如无，一律不得缩写，例：ISBN数据库：用一个或三个以下英文单词组成，单词首字母大写，如：DepartmentManage；表名：使用名词性质的单词全拼表示，各单词首字母大写， 使用复数形式，如：Books 如果该表用于表明另外两表中字段间的关系，用单数(即表明实体间的关系的表用单数命名),单词中间无“and of in”之类的介词 如：BookAuthor1. 表中的字段一般使用名词性质的单词全拼表示，采用一个或三个以下英文单词组成，单词首字母大写，如：UserName;2. 表主键名称为：表名+ID，如Document表的主键名为：DocumentID3. 外键名称位：主表名+对应列名，如：DepartmentsID，说明如下： 在表Departments中，其字段有：ID, DepartmentName 在表UserInfo中，其字段有： UserId,UserName,DepartmentsID DepartmentsID为外键4. 表中自动增长的列一律命名为：ID；5. 如果字段为bool型，则使用IsShow,IsValid,H