C#编码规范
注记:
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;
…
}
}
不要使用匈牙利方法来命名变量。
以前,多数程序员喜欢把数据类型作为变量名的前缀而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) ,而不是另外取名。变量名中不使用下划线 (_) 。命名空间需按照标准的模式命名。文件名要和类名匹配,例如,对于类HelloWorld,相应的文件名应为helloworld.cs (或,helloworld.vb)缩进和间隔
缩进用TAB。不用 SPACES。注释需和代码对齐。花括弧 ( {} ) 需和括号外的代码对齐。用一个空行来分开代码的逻辑分组。
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;
}
这段代码看起来比上面的好:
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;
}
在一个类中,各个方法需用一空行,也只能是一行分开。花括弧需独立一行,而不象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++)
{
//
}
}
注释
别每行代码,每个声明的变量都做注释。在需要的地方注释。可读性强的代码需要很少的注释,如果所有的变量和方法的命名都很有意义,会使代码可读性很强并无需太多注释。行数不多的注释会使代码看起来优雅。但如果代码不清晰,可读性差,那就糟糕。如果因为某种原因使用了复杂艰涩的原理,为程序配备良好的文档和重分的注释。对一个数值变量采用不是0,-1等的数值初始化,给出选择该值的理由。简言之,要写清晰,可读的代码以致无须什么注释就能理解。对注释做拼写检查,保证语法和标点符号的正确使用。
异常处理
不要“捕捉了异常却什么也不做”。如果隐藏了一个异常,你将永远不知道异常到底发生了没有。发生异常时,给出友好的消息给用户,但要精确记录错误的所有可能细节,包括发生的时间,和相关方法,类名等。只捕捉特定的异常,而不是一般的异常。
好:
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 "";
}
}
不必在所有方法中捕捉一般异常。不管它,让程序崩溃。这将帮助你在开发周期发现大多数的错误。你可以用应用程序级(线程级)错误处理器处理所有一般的异常。遇到“意外的一般性错误”时,此错误处理器应该捕捉异常,给用户提示消息,在应用程序关闭或用户选择“忽略并继续”之前记录错误信息。不必每个方法都用try-catch。当特定的异常可能发生时才使用。比如,当你写文件时,处理异常FileIOException。别写太大的 try-catch 模块。如果需要,为每个执行的任务编写单独的 try-catch 模块。这将帮你找出哪一段代码产生异常,并给用户发出特定的错误消息如果应用程序需要,可以编写自己的异常类。自定义异常不应从基类SystemException派生,而要继承于IApplicationException。
