C#编码规范和编程好习惯.doc

谁都会写代码！几个月的编程经验可以让你写出“可运行应用程序”。让它可运行容易，但是以最有效率的方式编码就需要下更多的功夫！ 中国3S吧 3要知道，大多数程序员在写“可运行代码”而不是“高效代码”。我们在这个指南课程前面提到，你想成为你们公司“最尊贵的专业人员”吗？写“高效代码”是一项艺术，你必须学习和实践它。 中国3S吧 3 命名惯例和规范 中国3S吧 3注记：Pascal 大小写形式所有单词第一个字母大写，其他字母小写。 中国3S吧 3 Camel 大小写形式除了第一个单词，所有单词第一个字母大写，其他字母小写。 专业的3S站 3 类名使用Pascal 大小写形式 中国3S吧 3publicclassHelloWorld. 专业的3S站 3 中国3S吧 3 方法使用Pascal 大小写形式 专业的3S站 3publicclassHelloWorldvoidSayHello(stringname). 中国3S吧 3 专业的3S站 3 变量和方法参数使用Camel 大小写形式 中国3S吧 3 publicclassHelloWorldinttotalCount=0;voidSayHello(stringname) 中国3S吧 3 stringfullMessage=Hello+name;. 专业的3S站 3 专业的3S站 3 不要使用匈牙利方法来命名变量 中国3S吧 3 以前，多数程序员喜欢它把数据类型作为变量名的前缀而m_作为成员变量的前缀。例如： 中国3S吧 3stringm_sName;intnAge; 专业的3S站 3 专业的3S站 3 然而，这种方式在.NET编码规范中是不推荐的。所有变量都用camel 大小写形式，而不是用数据类型和m_来作前缀。 专业的3S站 3 用有意义的，描述性的词语来命名变量 中国3S吧 3 - 别用缩写。用name, address, salary等代替 nam, addr, sal 。 专业的3S站 3- 别使用单个字母的变量象i, n, x 等。使用 index, temp等。 专业的3S站 3用于循环迭代的变量例外： 专业的3S站 3 for ( int i = 0; i count; i+ ) . 专业的3S站 3 中国3S吧 3 专业的3S站 3如果变量只用于迭代计数，没有在循环的其他地方出现，许多人还是喜欢用单个字母的变量(i) ，而不是另外取名。 中国3S吧 3- 变量名中不使用下划线 (_) 。 中国3S吧 3- 命名空间需按照标准的模式命名. 专业的3S站 3文件名要和类名匹配 中国3S吧 3 例如，对于类HelloWorld, 相应的文件名应为 helloworld.cs (或, helloworld.vb) 中国3S吧 3 缩进和间隔 专业的3S站 3 缩进用 TAB 不用 SPACES。 中国3S吧 3注释需和代码对齐。 中国3S吧 3花括弧 ( ) 需和括号外的代码对齐。 专业的3S站 3用一个空行来分开代码的逻辑分组。 专业的3S站 3 boolSayHello(stringname)stringfullMessage=Hello+name;DateTimecurrentTime=DateTime.Now; 中国3S吧 3 stringmessage=fullMessage+,thetimeis:+currentTime.ToShortTimeString(); 专业的3S站 3 MessageBox.Show(message); 专业的3S站 3 if(.) 中国3S吧 3 /Dosomething/.returnfalse; 中国3S吧 3 returntrue; 专业的3S站 3 中国3S吧 3 专业的3S站 3 专业的3S站 3这段代码看起来比上面的好： 专业的3S站 3 bool SayHello ( string name ) string fullMessage = Hello + name; DateTime currentTime = DateTime.Now; string message = fullMessage + , the time is : + currentTime.ToShortTimeString(); MessageBox.Show ( message ); if ( . ) / Do something / . return false; return true; 中国3S吧 3 中国3S吧 3 专业的3S站 3 在一个类中，各个方法需用一空行，也只能是一行分开。 花括弧需独立一行，而不象if, for 等可以跟括号在同一行。 专业的3S站 3好： 中国3S吧 3 if(.)/Dosomething 专业的3S站 3 专业的3S站 3 不好： 中国3S吧 3 if(.)/Dosomething 专业的3S站 3 专业的3S站 3在每个运算符和括号的前后都空一格。 专业的3S站 3 好： 专业的3S站 3 if(showResult=true)for(inti=0;i10;i+) 中国3S吧 3 / 专业的3S站 3 专业的3S站 3不好： 中国3S吧 3 if(showResult=true) for(int i= 0;i10;i+) / 专业的3S站 3 专业的3S站 3 专业的3S站 3 良好的编程习惯 中国3S吧 3遵从以下良好的习惯以写出好程序 专业的3S站 3 boolSayHello(stringname)stringfullMessage=Hello+name;DateTimecurrentTime=DateTime.Now; 专业的3S站 3 stringmessage=fullMessage+,thetimeis:+currentTime.ToShortTimeString();MessageBox.Show(message);if(.) 中国3S吧 3 /Dosomething/.returnfalse;returntrue; 中国3S吧 3 中国3S吧 3 避免使用大文件。如果一个文件里的代码超过300400行，必须考虑将代码分开到不同类中。 专业的3S站 3 避免写太长的方法。一个典型的方法代码在125行之间。如果一个方法发代码超过25行，应该考虑将其分解为不同的方法。 专业的3S站 3方法名需能看出它作什么。别使用会引起误解的名字。如果名字一目了然，就无需用文档来解释方法的功能了。 专业的3S站 3 好： 专业的3S站 3 voidSavePhoneNumber(stringphoneNumber)/Savethephonenumber. 专业的3S站 3 中国3S吧 3不好： 专业的3S站 3/Thismethodwillsavethephonenumber.voidSaveData(stringphoneNumber)/Savethephonenumber. 专业的3S站 3 中国3S吧 3 中国3S吧 3 一个方法只完成一个任务。不要把多个任务组合到一个方法中，即使那些任务非常小。 中国3S吧 3 好： 中国3S吧 3 / Save the address. SaveAddress ( address ); / Send an email to the supervisor to inform that the address is updated. SendEmail ( address, email ); void SaveAddress ( string address ) / Save the address. / . void SendEmail ( string address, string email ) / Send an email to inform the supervisor that the address is changed. / . 专业的3S站 3 专业的3S站 3 中国3S吧 3 不好： 专业的3S站 3 / Save address and send an email to the supervisor to inform that the address is updated. SaveAddress ( address, email ); void SaveAddress ( string address, string email ) / Job 1. / Save the address. / . / Job 2. / Send an email to inform the supervisor that the address is changed. / . 中国3S吧 3 中国3S吧 3 中国3S吧 3 使用C# 或 VB.NET的特有类型，而不是System命名空间中定义的别名类型。 专业的3S站 3好： 专业的3S站 3 intage;stringname;objectcontactInfo; 中国3S吧 3 中国3S吧 3 不好： 中国3S吧 3 Int16 age; String name; Object contactInfo; 中国3S吧 3 中国3S吧 3 别在程序中使用固定数值，用常量代替。 中国3S吧 3 别用字符串常数。用资源文件。 中国3S吧 3避免使用很多成员变量。声明局部变量，并传递给方法。不要在方法间共享成员变量。如果在几个方法间共享一个成员变量，那就很难知道是哪个方法在什么时候修改了它的值。 专业的3S站 3 必要时使用enum 。别用数字或字符串来指示离散值。花括弧需独立一行，而不象if, for 等可以跟括号在同一行。 专业的3S站 3好： 中国3S吧 3 if(.)/Dosomething 专业的3S站 3 专业的3S站 3 不好： 中国3S吧 3 if(.)/Dosomething 专业的3S站 3 专业的3S站 3在每个运算符和括号的前后都空一格。 专业的3S站 3 好： 专业的3S站 3 if(showResult=true)for(inti=0;i10;i+) 中国3S吧 3 / 专业的3S站 3 专业的3S站 3不好： 中国3S吧 3 if(showResult=true) for(int i= 0;i10;i+) / 专业的3S站 3 专业的3S站 3 专业的3S站 3 良好的编程习惯 中国3S吧 3遵从以下良好的习惯以写出好程序 专业的3S站 3 boolSayHello(stringname)stringfullMessage=Hello+name;DateTimecurrentTime=DateTime.Now; 专业的3S站 3 stringmessage=fullMessage+,thetimeis:+currentTime.ToShortTimeString();MessageBox.Show(message);if(.) 中国3S吧 3 /Dosomething/.returnfalse;returntrue; 中国3S吧 3 中国3S吧 3 避免使用大文件。如果一个文件里的代码超过300400行，必须考虑将代码分开到不同类中。 专业的3S站 3 避免写太长的方法。一个典型的方法代码在125行之间。如果一个方法发代码超过25行，应该考虑将其分解为不同的方法。 专业的3S站 3方法名需能看出它作什么。别使用会引起误解的名字。如果名字一目了然，就无需用文档来解释方法的功能了。 专业的3S站 3 好： 专业的3S站 3 voidSavePhoneNumber(stringphoneNumber)/Savethephonenumber. 专业的3S站 3 中国3S吧 3不好： 专业的3S站 3/Thismethodwillsavethephonenumber.voidSaveData(stringphoneNumber)/Savethephonenumber. 专业的3S站 3 中国3S吧 3 中国3S吧 3 一个方法只完成一个任务。不要把多个任务组合到一个方法中，即使那些任务非常小。 中国3S吧 3 好： 中国3S吧 3 / Save the address. SaveAddress ( address ); / Send an email to the supervisor to inform that the address is updated. SendEmail ( address, email ); void SaveAddress ( string address ) / Save the address. / . void SendEmail ( string address, string email ) / Send an email to inform the supervisor that the address is changed. / . 专业的3S站 3 专业的3S站 3 中国3S吧 3 不好： 专业的3S站 3 / Save address and send an email to the supervisor to inform that the address is updated. SaveAddress ( address, email ); void SaveAddress ( string address, string email ) / Job 1. / Save the address. / . / Job 2. / Send an email to inform the supervisor that the address is changed. / . 中国3S吧 3 中国3S吧 3 中国3S吧 3 使用C# 或 VB.NET的特有类型，而不是System命名空间中定义的别名类型。 专业的3S站 3好： 专业的3S站 3 intage;stringname;objectcontactInfo; 中国3S吧 3 中国3S吧 3 不好： 中国3S吧 3 Int16 age; String name; Object contactInfo; 中国3S吧 3 中国3S吧 3 别在程序中使用固定数值，用常量代替。 中国3S吧 3 别用字符串常数。用资源文件。 中国3S吧 3避免使用很多成员变量。声明局部变量，并传递给方法。不要在方法间共享成员变量。如果在几个方法间共享一个成员变量，那就很难知道是哪个方法在什么时候修改了它的值。 专业的3S站 3 必要时使用enum 。别用数字或字符串来指示离散值。好： enumMailTypeHtml,PlainText,AttachmentvoidSendMail(stringmessage,MailTypemailType)switch(mailType)caseMailType.Html: 中国3S吧 3 /Dosomethingbreak;caseMailType.PlainText:/Dosomethingbreak; 专业的3S站 3 caseMailType.Attachment:/Dosomethingbreak;default:/Dosomethingbreak; 专业的3S站 3 专业的3S站 3 中国3S吧 3不好： 中国3S吧 3 voidSendMail(stringmessage,stringmailType)switch(mailType)caseHtml: 中国3S吧 3 /Dosomethingbreak;casePlainText:/Dosomething 专业的3S站 3 break;caseAttachment:/Dosomethingbreak; 中国3S吧 3 default:/Dosomethingbreak; 中国3S吧 3 中国3S吧 3 别把成员变量声明为 public 或 protected。都声明为 private 而使用 public/protected 的Properties。 中国3S吧 3不在代码中使用具体的路径和驱动器名。 使用相对路径，并使路径可编程。 专业的3S站 3永远别设想你的代码是在“C:”盘运行。你不会知道，一些用户在网络或“Z:”盘运行程序。 中国3S吧 3应用程序启动时作些“自检”并确保所需文件和附件在指定的位置。必要时检查数据库连接。出现任何问题给用户一个友好的提示。 中国3S吧 3 如果需要的配置文件找不到，应用程序需能自己创建使用默认值的一份。 专业的3S站 3 如果在配置文件中发现错误值，应用程序要抛出错误，给出提示消息告诉用户正确值。 中国3S吧 3错误消息需能帮助用户解决问题。永远别用象“应用程序出错”，“发现一个错误” 等错误消息。而应给出象“更新数据库失败。请确保登陆id和密码正确。”的具体消息。 专业的3S站 3 显示错误消息时，除了说哪里错了，还应提示用户如何解决问题。不要用象“更新数据库失败。”这样的，要提示用户怎么做：“更新数据库失败。请确保登陆id和密码正确。” 专业的3S站 3显示给用户的消息要简短而友好。但要把所有可能的信息都记录下来，以助诊断问题。 专业的3S站 3注释 专业的3S站 3别每行代码，每个声明的变量都做注释。 中国3S吧 3在需要的地方注释。可读性强的代码需要很少的注释。如果所有的变量和方法的命名都很有意义，会使代码可读性很强并无需太多注释。 中国3S吧 3 行数不多的注释会使代码看起来优雅。但如果代码不清晰，可读性差，那就糟糕。 中国3S吧 3如果应为某种原因使用了复杂艰涩的原理，为程序配备良好的文档和重分的注释。 专业的3S站 3 对一个数值变量采用不是0,-1等的数值初始化，给出选择该值的理由。 专业的3S站 3 简言之，要写清晰，可读的代码以致无须什么注释就能理解。 专业的3S站 3对注释做拼写检查，保证语法和标点符号的正确使用。 专业的3S站 3异常处理 专业的3S站 3 不要“捕捉了异常却什么也不做”。如果隐藏了一个异常，你将永远不知道异常到底发生了没有。 专业的3S站 3 发生异常时，给出友好的消息给用户，但要精确记录错误的所有可能细节，包括发生的时间，和相关方法，类名等。 专业的3S站 3 只捕捉特定的异常，而不是一般的异常。 中国3S吧 3好： 中国3S吧 3 voidReadFromFile(stringfileName)try/readfromfile.catch(FileIOExceptionex) 中国3S吧 3 /logerror./re-throwexceptiondependingonyourcase.throw; 专业的3S站 3 专业的3S站 3 不好： 中国3S吧 3voidReadFromFile(stringfileName)try/readfromfile.catch(Exceptionex) 专业的3S站 3 /Catchinggeneralexceptionisbad.wewillneverknowwhetherit/wasafileerrororsomeothererror./Hereyouarehidinganexception./Inthiscasenoonewilleverknowthatanexceptionhappened. 专业的3S站 3 return; 专业的3S站 3 专业的3S站 3不必在所有方法中捕捉一般异常。不管它，让程序崩溃。这将帮助你在开发周期发现大多数的错误。 专业的3S站 3你可以用应用程序级（线程级）错误处理器处理所有一般的异常。遇到”以外的一般性错误“时，此错误处理器应该捕捉异常，给用户提示消息，在应用程序关闭或 用户选择”忽略并继续“之前记录错误信息。 专业的3S站 3不必每个方法都用try-catch。当特定的异常可能发生时才使用。比如，当你写文件时，处理异常FileIOException. 专业的3S站 3别写太大的 try-catch 模块。如果需要，为每个执行的任务编写单独的 try-catch 模块。 这将帮你找出哪一段代码产生异常，并给用户发出特定的错误消息。 中国3S吧 3如果应用程序需要，可以编写自己的异常类。自定义异常不应从基类SystemException派生，而要继承于IApplicationException。 专业的3S站 3 不好： 中国3S吧 3 /Savetheaddress.SaveAddress(address);/Sendanemailtothesupervisortoinformthattheaddressisupdated.SendEmail(address,email); 中国3S吧 3 voidSaveAddress(stringaddress)/Savetheaddress./.voidSendEmail(stringaddress,stringemail) 中国3S吧 3 /Sendanemailtoinformthesupervisorthattheaddressischanged./. 中国3S吧 3 专业的3S站 3 好： 中国3S吧 3 /Saveaddressandsendanemailtothesupervisortoinformthattheaddressisupdated.SaveAddress(address,email);voidSaveAddress(stringaddress,stringemail) 中国3S吧 3 /Job1./Savetheaddress././Job2./Sendanemailtoinformthesupervisorthattheaddressischanged./. 专业的3S站 3 中国3S吧 3 中国3S吧 3好： enumMailTypeHtml,PlainText,AttachmentvoidSendMail(stringmessage,MailTypemailType)switch(mailType)caseMailType.Html: 中国3S吧 3 /Dosomethingbreak;caseMailType.PlainText:/Dosomethingbreak; 专业的3S站 3 caseMailType.Attachment:/Dosomethingbreak;default:/Dosomethingbreak; 专业的3S站 3 专业的3S站 3 中国3S吧 3不好： 中国3S吧 3 voidSendMail(stringmessage,stringmailType)switch(mailType)caseHtml: 中国3S吧 3 /Dosomethingbreak;casePlainText:/Dosomething 专业的3S站 3 break;caseAttachment:/Dosomethingbreak; 中国3S吧 3 default:/Dosomethingbreak; 中国3S吧 3 中国3S吧 3 别把成员变量声明为 public 或 protected。都声明为 private 而使用 public/protected 的Properties。 中国3S吧 3不在代码中使用具体的路径和驱动器名。 使用相对路径，并使路径可编程。 专业的3S站 3永远别设想你的代码是在“C:”盘运行。你不会知道，一些用户在网络或“Z:”盘运行程序。 中国3S吧 3应用程序启动时作些“自检”并确保所需文件和附件在指定的位置。必要时检查数据库连接。出现任何问题给用户一个友好的提示。 中国3S吧 3 如果需要的配置文件找不到，应用程序需能自己创建使用默认值的一份。 专业的3S站 3 如果在配置文件中发现错误值，应用程序要抛出错误，给出提示消息告诉用户正确值。 中国3S吧 3错误消息需能帮助用户解决问题。永远别用象“应用程序出错”，“发现一个错误” 等错误消息。而应给出象“更新数据库失败。请确保登陆id和密码正确。”的具体消息。 专业的3S站 3 显示错误消息时，除了说哪里错了，还应提示用户如何解决问题。不要用象“更新数据库失败。”这样的，要提示用户怎么做：“更新数据库失败。请确保登陆id和密码正确。” 专业的3S站 3显示给用户的消息要简短而友好。但要把所有可能的信息都记录下来，以助诊断问题。 专业的3S站 3注释 专业的3S站 3别每行代码，每个声明的变量都做注释。 中国3S吧 3在需要的地方注释。可读性强的代码需要很少的注释。如果所有的变量和方法的命名都很有意义，会使代码可读性很强并无需太多注释。 中国3S吧 3 行数不多的注释会使代码看起来优雅。但如果代码不清晰，可读性差，那就糟糕。 中国3S吧 3如果应为某种原因使用了复杂艰涩的原理，为程序配备良好的文档和重分的注释。 专业的3S站 3 对一个数值变量采用不是0,-1等的数值初始化，给出选择该值的理由。 专业的3S站 3 简言之，要写清晰，可读的代码以致无须什么注释就能理解。 专业的3S站 3对注释做拼写检查，保证语法和标点符号的正确使用。 专业的3S站 3异常处理 专业的3S站 3 不要“捕捉了异常却什么也不做”。如果隐藏了一个异常，你将永远不知道异常到底发生了没有。 专业的3S站 3 发生异常时，给出友好的消息给用户，但要精确记录错误的所有可能细节，包括发生的时间，和相关方法，类名等。 专业的3S站 3 只捕捉特定的异常，而不是一般的异常。 中国3S吧 3好： 中国3S吧 3 voidReadFromFile(stringfileName)try/readfromfile.catch(FileIOExceptionex) 中国3S吧 3 /logerror./re-throwexceptiondependingonyourcase.throw; 专业的3S站 3 专业的3S站 3 不好： 中国3S吧 3voidReadFromFile(stringfile