C#语言开发规范

        继前次发表文章已是一年前了，太懒了^_^

        现在开始用C#开发，先整理一下开发规范。

C#开发规范

1．  定义

Pascal大写：一种大小写形式，所有单词第一个字母大写，其他字母小写。

Camel 大写：一种大小写形式，除了第一个单词，所有单词第一个字母大写，其他字母小写。

例：HelloWorld（Pascal大写），helloWorld（Camel 大写）。

Camel 大写主要用于变量命名规范，其他命名多用Pascal大写，例如：类名、文件名，等等。

 

2．  规范

命名的宗旨：见名思义。能够使查阅者看到名称就知道：类型、含义。例：接口名称以“I”开头，表示interface。

缩进与间隔：使代码美观，易于理解。

良好的编程习惯：保持严谨的逻辑，利于少走弯路。也是重构的思想。

a)         类的命名规范

Ø       用名词或名词短语命名类。

Ø       使用Pascal大写。

Ø       减少类名中缩写的使用量。

Ø       不要使用任何类前缀。

Ø       不要使用带下划线的字符。

下面是一些正确命名的类名的例子。

public class FileStream {

}

public class Button {

}

          PS：C++规范中在类名前加“C”，表示改名字为类名。

b)        接口的命名规范

Ø       使用名词或名词短语，或者描述行为的形容词来命名接口。

例如，IComponent（描述性名词），ICustomAttributeProvider（名词短语），和IPersistable（形容词）。

Ø       使用Pascal大写。

Ø       减少接口名中缩写的使用量。

Ø       不要使用带下划线的字符。

Ø       在接口名前加前缀I，以表示这个类型是一个接口。

Ø       不要在类名前加上前缀C。

偶尔情况下，需要在类名前加上I而并不表示它是一个接口。在这种情况下，只要I后面的字符是小写就可（例如，IdentityStore。）

Ø       当类是接口的标准执行时，定义这一对类/接口组合就要使用相似的名称。两个名称的不同之处只是接口名前有一个I前缀。

下面我们举个例子，来看看接口IComponent和它的标准执行，类Component。

public interface IComponent {

}

 

public class Component : IComponent{

}

public interface IServiceProvider{

}

public interface IFormatable {

}

PS：接口的命名同类命名规范，仅加上以“I”前缀。

c)        方法命名规范

Ø       用动词或动词短语命名方法。

Ø       用下述范例所示的Pascal大写方式命名方法。

RemoveAll()

GetCharArray()

Invoke()

PS：方法即操作，动词也！

d)        属性命名规范

Ø       用名词或名词短语命名属性。

Ø       用Pascal大写命名属性。

Ø       属性与类型要一样。

PS：属性是C#中区别于其他语言中的一种元素，其结合访问器相当于JavaBean中get，set方法，又有区别；属性也不同于字段。

e)         变量命名规范

Ø       变量和方法参数使用Camel 大小写形式

public class HelloWorld

{

int totalCount = 0;

void SayHello(string name)

{

string fullMessage = "Hello " + name;

...

}

}

Ø       不要使用匈牙利方法来命名变量。

以前，多数程序员喜欢它－把数据类型作为变量名的前缀而m_作为成员变量的前缀。例如：

string m_sName;

int nAge;

然而，这种方式在.NET编码规范中是不推荐的。所有变量都用camel 大小写形式，而不是用数据类型和m_来作前缀。          

Ø       用有意义的，描述性的词语来命名变量。

- 别用缩写。用name, address, salary等代替 nam, addr, sal

- 别使用单个字母的变量象i, n, x 等. 使用 index, temp等

- 用于循环迭代的变量例外：

for ( int i = 0; i < count; i++ )

{

...

}

如果变量只用于迭代计数，没有在循环的其他地方出现，许多人还是喜欢用单个字母的变量(i) ，而不是另外取名。

- 变量名中不使用下划线 (_) 。

- 命名空间需按照标准的模式命名。

PS：C++中一直用匈牙利方法来命名变量，C#又有新的命名规范，随了！C#中也不习惯在名称中用“_”。

f)         文件名要和类名匹配

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

PS：同Java。

g)        缩进和间隔

Ø       缩进用 TAB，不用 SPACES。

Ø       注释需和代码对齐。

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

Ø       在一个类中，各个方法需用一空行，也只能是一行分开。

Ø       花括弧需独立一行，而不象if, for 等可以跟括号在同一行。

好：

if ( ... )

{

    // Do something

}

不好：

if ( ... ) {

    // Do something

}

Ø       在每个运算符前后都空一格。

好：

if (showResult == true)

{

    for (int i = 0; i < 10; i++)

    {

     //

    }

}

不好：

if(showResult==true)

{

    for(int i= 0;i<10;i++)

    {

     //

    }

}

              PS：.NET中花括弧{独立一行，然后回车，比较好用^_^。每个运算符前后都空一格，原来只是在关系/逻辑运算符前后空格，以后改正^_^。

h)        良好的编程习惯

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

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

Ø       方法名需能看出它作什么。别使用会引起误解的名字。如果名字一目了然，就无需用文档来解释方法的功能了（重构中一招）。

好：

void SavePhoneNumber ( string phoneNumber )

{

// Save the phone number.

}

 

不好：

// This method will save the phone number.

void SaveData ( string phoneNumber )

{

// Save the phone number.

}

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

好：

// 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.

// ...

}

 

不好：

// 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.

// ...

}

Ø       使用C# 或 VB.NET的特有类型，而不是System命名空间中定义的别名类型。

好：

int age;

string name;

object contactInfo;

 

不好：

Int16 age;

String name;

Object contactInfo;

Ø       别在程序中使用固定数值，用常量代替。

Ø       别用字符串常数，用资源文件（这个要注意了，平时忽略了）。

Ø       避免使用很多成员变量。声明局部变量，并传递给方法。不要在方法间共享成员变量。如果在几个方法间共享一个成员变量，那就很难知道是哪个方法在什么时候修改了它的值。

Ø       必要时使用enum，别用数字或字符串来指示离散值（想到的好处：易读，可以少些注释了^_^）。

好：

enum MailType

{

Html,

PlainText,

Attachment

}

void SendMail (string message, MailType mailType)

{

switch ( mailType )

{

    case MailType.Html:

     // Do something

     break;

    case MailType.PlainText:

     // Do something

     break;

    case MailType.Attachment:

     // Do something

     break;

    default:

     // Do something

     break;

}

}

           

不好：

void SendMail (string message, string mailType)

{

switch ( mailType )

{

    case "Html":

     // Do something

     break;

    case "PlainText":

     // Do something

     break;

    case "Attachment":

     // Do something

     break;

    default:

     // Do something

     break;

}

}

Ø       别把成员变量声明为 public 或 protected。一般声明为 private 而使用 public/protected 的Properties.

Ø       不在代码中使用具体的路径和驱动器名。 使用相对路径，并使路径可编程。

Ø       永远别设想你的代码是在“C:”盘运行。你不会知道，一些用户在网络或“Z:”盘运行程序。

Ø       应用程序启动时作些“自检”并确保所需文件和附件在指定的位置。必要时检查数据库连接。出现任何问题给用户一个友好的提示。（值得借鉴）

Ø       如果需要的配置文件找不到，应用程序需能自己创建使用默认值的一份。

Ø       如果在配置文件中发现错误值，应用程序要抛出错误，给出提示消息告诉用户正确值。

Ø       错误消息需能帮助用户解决问题。永远别用象"应用程序出错", "发现一个错误" 等错误消息。而应给出象 "更新数据库失败。请确保登陆id和密码正确。" 的具体消息。  

Ø       显示错误消息时，除了说哪里错了，还应提示用户如何解决问题。不要用 象 "更新数据库失败。"这样的，要提示用户怎么做："更新数据库失败。请确保登陆id和密码正确。

Ø       显示给用户的消息要简短而友好。但要把所有可能的信息都记录下来，以助诊断问题。

i)          注释

Ø       别每行代码，每个声明的变量都做注释。

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

Ø       行数不多的注释会使代码看起来优雅。但如果代码不清晰，可读性差，那就糟糕。

Ø       如果应为某种原因使用了复杂艰涩的原理，为程序配备良好的文档和重分的注释。

j)          异常处理

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

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

Ø       别写太大的 try-catch 模块。如果需要，为每个执行的任务编写单独的 try-catch 模块。 这将帮你找出哪一段代码产生异常，并给用户发出特定的错误消息

Ø       如果应用程序需要，可以编写自己的异常类。自定义异常不应从基类SystemException派生，而要继承于. IApplicationException。

好：

void ReadFromFile ( string fileName )

{

try

{

    // read from file.

}

catch (FileIOException ex)

{

    // log error.

    // re-throw exception depending on your case.

    throw;

}

}

不好：

void ReadFromFile ( string fileName )

{

try

{

    // read from file.

}

catch (Exception ex)

   {

    // Catching general exception is bad... we will never know whether it

    // was a file error or some other error.

  

    // Here you are hiding an exception.

    // In this case no one will ever know that an exception happened.

    return "";

   }

}