解析C#编程的通用结构和程序书写格式规范
C#程序的通用结构
C#程序可由一个或多个文件组成。每个文件都可以包含零个或零个以上的命名空间。一个命名空间除了可包含其他命名空间外，还可包含类、结构、接口、枚举、委托等类型。以下是C#程序的主干，它包含所有这些元素。
//AskeletonofaC#program
usingSystem;
namespaceYourNamespace
{
classYourClass
{
}
structYourStruct
{
}
interfaceIYourInterface
{
}
delegateintYourDelegate();
enumYourEnum
{
}
namespaceYourNestedNamespace
{
structYourStruct
{
}
}
classYourMainClass
{
staticvoidMain(string[]args)
{
//Yourprogramstartshere...
}
}
}
C#编码约定
C#语言规范未定义编码标准。但是，Microsoft根据本主题中的准则来开发样本和文档。
编码约定可实现以下目的：
- 它们为代码创建一致的外观，以确保读取器专注于内容而非布局。
- 它们使得读取器可以通过基于之前的经验进行的假设更快地理解代码。
- 它们便于复制、更改和维护代码。
- 它们展示C#最佳做法。
命名约定
在不包括using指令的短示例中，使用命名空间限定。如果你知道命名空间默认导入项目中，则不必完全限定来自该命名空间的名称。如果对于单行来说过长，则可以在点(.)后中断限定名称，如下面的示例所示。
varcurrentPerformanceCounterCategory=newSystem.Diagnostics. PerformanceCounterCategory();
你不必更改通过使用VisualStudio设计器工具创建的对象的名称以使它们适合其他准则。
布局约定
好的布局利用格式设置来强调代码的结构并使代码更便于阅读。Microsoft示例和样本符合以下约定：
- 使用默认的代码编辑器设置（智能缩进、4字符缩进、制表符保存为空格）。有关详细信息，请参阅选项、文本编辑器、C#、格式设置。
- 每行只写一条语句。
- 每行只写一个声明。
- 如果连续行未自动缩进，请将它们缩进一个制表符位（四个空格）。
- 在方法定义与属性定义之间添加至少一个空白行。
使用括号突出表达式中的子句，如下面的代码所示。
if((val1>val2)&&(val1>val3))
{
//Takeappropriateaction.
}
注释约定
将注释放在单独的行上，而非代码行的末尾。
以大写字母开始注释文本。
以句点结束注释文本。
在注释分隔符(//)与注释文本之间插入一个空格，如下面的示例所示。
//Thefollowingdeclarationcreatesaquery.Itdoesnotrun //thequery.
不要在注释周围创建格式化的星号块。
语言准则
以下各节介绍C#遵循以准备代码示例和样本的做法。
String数据类型
使用+运算符来连接短字符串，如下面的代码所示。
stringdisplayName=nameList[n].LastName+","+nameList[n].FirstName;
若要在循环中追加字符串，尤其是在使用大量文本时，请使用StringBuilder对象。
varphrase="lalalalalalalalalalalalalalalalalalalalalalalalalalalalalala";
varmanyPhrases=newStringBuilder();
for(vari=0;i<10000;i++)
{
manyPhrases.Append(phrase);
}
//Console.WriteLine("tra"+manyPhrases);
隐式类型的局部变量
当变量类型明显来自赋值的右侧时，或者当精度类型不重要时，请对本地变量进行隐式类型化。
//Whenthetypeofavariableisclearfromthecontext,usevar //inthedeclaration. varvar1="Thisisclearlyastring."; varvar2=27; varvar3=Convert.ToInt32(Console.ReadLine());
当类型并非明显来自赋值的右侧时，请勿使用var。
//Whenthetypeofavariableisnotclearfromthecontext,usean //explicittype. intvar4=ExampleClass.ResultSoFar();
请勿依靠变量名称来指定变量的类型。它可能不正确。
//NamingthefollowingvariableinputIntismisleading. //Itisastring. varinputInt=Console.ReadLine(); Console.WriteLine(inputInt);
避免使用var来代替dynamic。
使用隐式类型化来确定for和foreach循环中循环变量的类型。
下面的示例在for语句中使用隐式类型化。
varsyllable="ha";
varlaugh="";
for(vari=0;i<10;i++)
{
laugh+=syllable;
Console.WriteLine(laugh);
}
下面的示例在foreach语句中使用隐式类型化。
foreach(varchinlaugh)
{
if(ch=='h')
Console.Write("H");
else
Console.Write(ch);
}
Console.WriteLine();
无符号数据类型
通常，使用int而非无符号类型。int的使用在整个C#中都很常见，并且当你使用int时，更易于与其他库交互。
数组
当在声明行上初始化数组时，请使用简洁的语法。
//Preferredsyntax.Notethatyoucannotusevarhereinsteadofstring[].
string[]vowels1={"a","e","i","o","u"};
//Ifyouuseexplicitinstantiation,youcanusevar.
varvowels2=newstring[]{"a","e","i","o","u"};
//Ifyouspecifyanarraysize,youmustinitializetheelementsoneatatime.
varvowels3=newstring[5];
vowels3[0]="a";
vowels3[1]="e";
//Andsoon.
委托
使用简洁的语法来创建委托类型的实例。
//First,inclassProgram,definethedelegatetypeandamethodthat
//hasamatchingsignature.
//Definethetype.
publicdelegatevoidDel(stringmessage);
//Defineamethodthathasamatchingsignature.
publicstaticvoidDelMethod(stringstr)
{
Console.WriteLine("DelMethodargument:{0}",str);
}
//IntheMainmethod,createaninstanceofDel.
//Preferred:CreateaninstanceofDelbyusingcondensedsyntax.
DelexampleDel2=DelMethod;
//Thefollowingdeclarationusesthefullsyntax.
DelexampleDel1=newDel(DelMethod);
异常处理中的try-catch和using语句
对大多数异常处理使用try-catch语句。
staticstringGetValueFromArray(string[]array,intindex)
{
try
{
returnarray[index];
}
catch(System.IndexOutOfRangeExceptionex)
{
Console.WriteLine("Indexisoutofrange:{0}",index);
throw;
}
}
通过使用C#using语句简化你的代码。如果你具有try-finally语句（该语句中finally块的唯一代码是对Dispose方法的调用），请使用using语句代替。
//Thistry-finallystatementonlycallsDisposeinthefinallyblock.
Fontfont1=newFont("Arial",10.0f);
try
{
bytecharset=font1.GdiCharSet;
}
finally
{
if(font1!=null)
{
((IDisposable)font1).Dispose();
}
}
//Youcandothesamethingwithausingstatement.
using(Fontfont2=newFont("Arial",10.0f))
{
bytecharset=font2.GdiCharSet;
}
&&和||运算符
若要通过跳过必要的比较来避免异常和提高性能，请在执行比较时使用&&来代替&，使用||来代替|，如下面的示例所示。
Console.Write("Enteradividend:");
vardividend=Convert.ToInt32(Console.ReadLine());
Console.Write("Enteradivisor:");
vardivisor=Convert.ToInt32(Console.ReadLine());
//Ifthedivisoris0,thesecondclauseinthefollowingcondition
//causesarun-timeerror.The&&operatorshortcircuitswhenthe
//firstexpressionisfalse.Thatis,itdoesnotevaluatethe
//secondexpression.The&operatorevaluatesboth,andcauses
//arun-timeerrorwhendivisoris0.
if((divisor!=0)&&(dividend/divisor>0))
{
Console.WriteLine("Quotient:{0}",dividend/divisor);
}
else
{
Console.WriteLine("Attempteddivisionby0endsuphere.");
}
New运算符
隐式类型化时，请使用对象实例化的简洁形式，如下面的声明所示。
varinstance1=newExampleClass();
上一行等同于下面的声明。
ExampleClassinstance2=newExampleClass();
使用对象初始值设定项来简化对象创建。
//Objectinitializer.
varinstance3=newExampleClass{Name="Desktop",ID=37414,
Location="Redmond",Age=2.3};
//Defaultconstructorandassignmentstatements.
varinstance4=newExampleClass();
instance4.Name="Desktop";
instance4.ID=37414;
instance4.Location="Redmond";
instance4.Age=2.3;
事件处理
如果你正定义一个稍后不需要删除的事件处理程序，请使用lambda表达式。
publicForm2()
{
//Youcanusealambdaexpressiontodefineaneventhandler.
this.Click+=(s,e)=>
{
MessageBox.Show(
((MouseEventArgs)e).Location.ToString());
};
}
//Usingalambdaexpressionshortensthefollowingtraditionaldefinition.
publicForm1()
{
this.Click+=newEventHandler(Form1_Click);
}
voidForm1_Click(objectsender,EventArgse)
{
MessageBox.Show(((MouseEventArgs)e).Location.ToString());
}
静态成员
通过使用类名称调用静态成员：ClassName.StaticMember。这种做法通过明确静态访问使代码更易于阅读。请勿使用派生类的名称限定基类中定义的静态成员。编译该代码时，代码可读性具有误导性，如果向派生类添加具有相同名称的静态成员，代码可能会被破坏。
LINQ查询
对查询变量使用有意义的名称。下面的示例为位于西雅图的客户使用seattleCustomers。
varseattleCustomers=fromcustincustomers wherecust.City=="Seattle" selectcust.Name;
使用别名确保匿名类型的属性名称都使用Pascal大小写格式正确大写。
varlocalDistributors=
fromcustomerincustomers
joindistributorindistributorsoncustomer.Cityequalsdistributor.City
selectnew{Customer=customer,Distributor=distributor};
如果结果中的属性名称模棱两可，请对属性重命名。例如，如果你的查询返回客户名称和分销商ID，而不是在结果中将它们保留为Name和ID，请对它们进行重命名以明确Name是客户的名称，ID是分销商的ID。
varlocalDistributors2=
fromcustincustomers
joindistindistributorsoncust.Cityequalsdist.City
selectnew{CustomerName=cust.Name,DistributorID=dist.ID};
在查询变量和范围变量的声明中使用隐式类型化。
varseattleCustomers=fromcustincustomers wherecust.City=="Seattle" selectcust.Name;
对齐from子句下的查询子句，如上面的示例所示。
在其他查询子句之前使用where子句，以确保后面的查询子句作用于经过减少和筛选的数据集。
varseattleCustomers2=fromcustincustomers wherecust.City=="Seattle" orderbycust.Name selectcust;
使用多行from子句代替join子句以访问内部集合。例如，Student对象的集合可能包含测验分数的集合。当执行以下查询时，它返回高于90的分数，并返回得到该分数的学生的姓氏。
//Useacompoundfromtoaccesstheinnersequencewithineachelement.
varscoreQuery=fromstudentinstudents
fromscoreinstudent.Scores
wherescore>90
selectnew{Last=student.LastName,score};