<table id="table13" height="335" cellspacing="0" cellpadding="0" width="98%" border="0">
<tr>
<td style="FONT-SIZE: 10pt" align="middle" height="60">
C# 编码规范和编程好习惯
代码,而不是高效代码”。我们在这个指南课程前面提到,你想成为你们公司“最尊贵的专业人员”吗?写“高效代码”是一项艺术,你必须学习和实践它。
方法使用Pascal 大小写形式
方法参数使用Camel 大小写形式
方法来命名变量
文件名要和类名匹配
文件名应为 helloworld.cs (或,helloworld.vb)
代码对齐.。
代码对齐.。
代码的逻辑分组。.
Box.Show ( message ); if ( ... ) { // Do something // ... return false; } return true; }
代码看起来比上面的好::
Box.Show ( message ); if ( ... ) { // Do something // ... return false; } return true; }
方法需用一空行,也只能是一行分开。
文件。如果一个文件里的代码超过300~400行,必须考虑将代码分开到不同类中。
方法。一个典型的方法代码在1~25行之间。如果一个方法发代码超过25行,应该考虑将其分解为不同的方法。
方法名需能看出它作什么。别使用会引起误解的名字。如果名字一目了然,就无需用文档来解释方法的功能了。
方法只完成一个任务。不要把多个任务组合到一个方法中,即使那些任务非常小。
文件。
方法。不要在方法间共享成员变量。如果在几个方法间共享一个成员变量,那就很难知道是哪个方法在什么时候修改了它的值。
代码中使用具体的路径和驱动器名。 使用相对路径,并使路径可编程。
代码是在“C:”盘运行。你不会知道,一些用户在网络或“Z:”盘运行程序。
文件和附件在指定的位置。必要时检查数据库连接。出现任何问题给用户一个友好的提示。
配置文件找不到,应用程序需能自己创建使用默认值的一份。
配置文件中发现错误值,应用程序要抛出错误,给出提示消息告诉用户正确值。
错误消息需能帮助用户解决问题。永远别用象"应用程序出错","发现一个错误" 等错误消息。而应给出象 "更新数据库失败。请确保登陆id和密码正确。" 的具体消息。
显示错误消息时,除了说哪里错了,还应提示用户如何解决问题。不要用 象 "更新数据库失败。"这样的,要提示用户怎么做:"更新数据库失败。请确保登陆id和密码正确。"
显示给用户的消息要简短而友好。但要把所有可能的信息都记录下来,以助诊断问题。
代码,每个声明的变量都做注释。
代码需要很少的注释。如果所有的变量和方法的命名都很有意义,会使代码可读性很强并无需太多注释。
代码看起来优雅。但如果代码不清晰,可读性差,那就糟糕。
代码以致无须什么注释就能理解。
标点符号的正确使用。
用户,但要精确记录错误的所有可能细节,包括发生的时间,和相关方法,类名等。
方法中捕捉一般异常。不管它,让程序崩溃。这将帮助你在开发周期发现大多数的错误。
错误处理器处理所有一般的异常。遇到”以外的一般性错误“时,此错误处理器应该捕捉异常,给用户提示消息,在应用程序关闭或 用户选择”忽略并继续“之前记录错误信息。
方法都用try-catch。当特定的异常可能发生时才使用。比如,当你写文件时,处理异常FileIOException.
自定义异常不应从基类SystemException派生,而要继承于. IApplicationException。