Go homepage(回首页)
Upload pictures (上传图片)
Write articles (发文字帖)

The author:(作者)qq
published in(发表于) 2014/7/11 9:20:50
C#代码书写规则

C#代码书写规则

编码方法合并了软件开发的许多方面。尽管它们通常对应用程序的功能没有影响，但它们有助于对源代码的理解。养成良好的编码书写习惯对于软件的开发和维护都是很有益的，下面介绍一些代码书写规则。

建立标准的缩进大小（如4个空格），并一直使用此标准，用规定的缩进对齐代码节，沿逻辑结构行缩进代码。没有缩进，代码将变得难以理解。代码书写规则如下所示。

//http://www.isstudy.com

避免写过长的代码，如果代码的长度超过一行的宽度，将其写为两行。

花括弧 ( {} ) 需和括号外的代码对齐。

把所有系统框架提供的名称空间组织到一起，把第三方提供的名称空间放到系统名称空间的下面。

避免通过全限定方式使用类型名称，在程序开始时使用using关键字导入命名空间，可以帮助找出哪一段代码产生异常，并给用户发出特定的错误信息。

所有的类成员变量应该被声明在类的顶部，并用一个空行把它们和方法以及属性的声明区分开。

声明一个局部变量时，局部变量的位置要与使用位置靠近。

当一行被分为几行时，应将“+”串联运算符放在每一行的末尾。

不要使用goto系列语句，除非是用在跳出深层循环时。

if语句中，总使用一对{}把下面的语句块包含起来，即使只有一条语句也是如此。

编写HTML时，一种方法是建立标准的标记和属性格式，如所有标记都大写或所有属性都小写；另一种方法是坚持XHTML规范，以确保所有HTML文档都有效，应使用带引号的属性值和结束标记以方便维护。

避免在同一个文件中放置多个类。

避免使用大文件。如果一个文件里的代码超过300～400行，必需考虑将代码分开到不同类中。

避免写太长的方法。一个典型的方法代码在1～25行之间。如果一个方法的代码超过25行，应该考虑将其分解为不同的方法。

尽量使用接口，然后使用类实现接口，以提高程序的灵活性。

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

避免写超过5个参数的方法。如果要传递多个参数，那么可以使用结构。

如果捕捉到异常一定要进行异常处理。如果隐藏了一个异常，将永远不知道异常到底发生了没有。

发生异常时，提示友好的消息给用户，但要精确记录错误的所有可能细节，包括发生的时间、相关方法和类名等。

只捕捉特定的异常，而不是一般的异常。

在开发前期不必在所有方法中捕捉异常并进行处理。异常导致程序崩溃将有助于在开发周期发现大多数的错误。

避免书写代码量过大的 try-catch 模块。如果确实需要，那么可以为每个执行的任务编写单独的 try-catch 模块。

如果一个类或方法提供了泛型和非泛型版本，那么优先选择泛型版本。

关键的语句（包括声明关键的变量）必需要写注释，注释需和代码对齐。

赞