编码习惯

编码规范和编码好习惯

                                     写出‘高效代码’

---

一、命名惯例和规范

注记 :
Pascal 大小写形式－所有单词第一个字母大写，其他字母小写。
Camel 大小写形式－除了第一个单词，所有单词第一个字母大写，其他字母小写。命名惯例和规范。

类名使用Pascal 大小写形式 public class HelloWorld { ... }

方法使用Pascal 大小写形式 public class HelloWorld { void SayHello(string name) { ... } }

变量和方法参数使用Camel 大小写形式 public class HelloWorld { int totalCount = 0; void SayHello(string name) { string fullMessage = "Hello " + name; ... } }

//-用有意义、描述性的词语来命名变量，至少要让他人能看懂，针对需要命名，不能随便命名或Copy一变量，但给该变量赋的值却与该变量本身的意义毫无关系；

//- 别用缩写。用name, address, salary等代替 nam, addr, sal
//- 别使用单个字母的变量象i, n, x 等. 使用 index, temp等
//用于循环迭代的变量例外：

   for ( int i = 0; i < count; i++ )
  {
      ...
  }如果变量只用于迭代计数，没有在循环的其他地方出现，许多人还是喜欢用单个字母的变量(i) ，而不是另外取名。
//- 变量名中不使用下划线 (_) 。
//- 命名空间需按照标准的模式命名
...

二、文件名要和类名匹配

例如，对于类HelloWorld, 相应的文件名应为 helloworld.cs (或, helloworld.vb)

三、缩进和间隔

缩进用 TAB . 不用 SPACES.。

四、注释

在需要的地方注释。可读性强的代码需要很少的注释。如果所有的变量和方法的命名都很有意义，会使代码可读性很强并无需太多注释。

注释需和代码对齐。

注释语句应简单明了。

五、异常处理

不要“捕捉了异常却什么也不做“。如果隐藏了一个异常，你将永远不知道异常到底发生了没有。

发生异常时，给出友好的消息给用户，但要精确记录错误的所有可能细节，包括发生的时间，和相关方法，类名等。 只捕捉特定的异常，而不是一般的异常。

void ReadFromFile ( string fileName )

{

      try

     { 

         // read from file.

     }

     catch (FileIOException ex)

    {

        // log error. // re-throw exception depending on your case. throw;

    }

}

六、其它

花括弧 ( {} ) 需和括号外的代码对齐。
用在一个类中，各个方法需用一空行，也只能是一行分开。
用一个空行来分开代码的逻辑分组。括弧需独立一行，而不象if, for 等可以跟括号在同一行。

避免使用大文件。如果一个文件里的代码超过300～400行，必须考虑将代码分开到不同类中。
避免写太长的方法。一个典型的方法代码在1～25行之间。如果一个方法发代码超过25行，应该考虑将其分解为不同的方法。
方法名需能看出它作什么。别使用会引起误解的名字。如果名字一目了然，就无需用文档来解释方法的功能了。

一个方法只完成一个任务。不要把多个任务组合到一个方法中，即使那些任务非常小。

别在程序中使用固定数值，用常量代替。
别用字符串常数。用资源文件。
避免使用很多成员变量，声明局部变量，并传递给方法。

不要在方法间共享成员变量。如果在几个方法间共享一个成员变量，那就很难知道是哪个方法在什么时候修改了它的值。
必要时使用enum 。别用数字或字符串来指示离散值。

别把成员变量声明为 public 或 protected。都声明为 private 而使用 public/protected 的Properties.
不在代码中使用具体的路径和驱动器名。 使用相对路径，并使路径可编程。
应用程序启动时作些“自检”并确保所需文件和附件在指定的位置。必要时检查数据库连接。出现任何问题给用户一个友好的提示。
如果需要的配置文件找不到，应用程序需能自己创建使用默认值的一份。
如果在配置文件中发现错误值，应用程序要抛出错误，给出提示消息告诉用户正确值。
错误消息需能帮助用户解决问题。永远别用象"应用程序出错", "发现一个错误" 等错误消息。而应给出像 "更新数据库失败。请确保登陆id和密码正确。" 的具体消息。
显示错误消息时，除了说哪里错了，还应提示用户如何解决问题。不要用 象 "更新数据库失败。"这样的，要提示用户怎么做："更新数据库失败。请确保登陆id和密码正确。"
显示给用户的消息要简短而友好。但要把所有可能的信息都记录下来，以助诊断问题。