C#的编程规范.doc

命名惯例和规范注记：Pascal大小写形式－所有单词第一个字母大写，其他字母小写。Camel大小写形式－除了第一个单词，所有单词第一个字母大写，其他字母小写。
类名使用Pascal大小写形式
publicclassHelloWorld
{...
}方法使用Pascal大小写形式
publicclassHelloWorld
{
voidSayHello(stringname)
{
...
}
}<变量和方法参数使用Camel大小写形式
publicclassHelloWorld
{
inttotalCount=0;
voidSayHello(stringname)
{
stringfullMessage="Hello"+name;
...
}
}不要使用匈牙利方法来命名变量以前，多数程序员喜欢它－把数据类型作为变量名的前缀而m_作为成员变量的前缀。例如：stringm_sName;intnAge;
然而，这种方式在.NET编码规范中是不推荐的。所有变量都用camel大小写形式，而不是用数据类型和m_来作前缀。
用有意义的，描述性的词语来命名变量-别用缩写。用name,address,salary等代替nam,addr,sal-别使用单个字母的变量象i,n,x等.使用index,temp等用于循环迭代的变量例外：
for(inti=0;i<count;i++)
{
...
}
如果变量只用于迭代计数，没有在循环的其他地方出现，许多人还是喜欢用单个字母的变量(i)，而不是另外取名。-变量名中不使用下划线(_)。-命名空间需按照标准的模式命名
...
文件名要和类名匹配例如，对于类HelloWorld,相应的文件名应为helloworld.cs(或,helloworld.vb)
缩进和间隔
缩进用TAB.不用SPACES.。
注释需和代码对齐.。
花括弧({})需和括号外的代码对齐.。
用一个空行来分开代码的逻辑分组。.
boolSayHello(stringname)
{
stringfullMessage="Hello"+name;
DateTimecurrentTime=DateTime.Now;
stringmessage=fullMessage+",
thetimeis："+currentTime.ToShortTimeString();
MessageBox.Show(message);
if(...)
{
//Dosomething
//...
returnfalse;
}
returntrue;
}这段代码看起来比上面的好：
boolSayHello(stringname)
{
stringfullMessage="Hello"+name;
DateTimecurrentTime=DateTime.Now;
stringmessage=fullMessage+",
thetimeis："+currentTime.ToShortTimeString();
MessageBox.Show(message);
if(...)
{
//Dosomething
//...
returnfalse;
}
returntrue;
}在一个类中，各个方法需用一空行，也只能是一行分开。
花括弧需独立一行，而不象if,for等可以跟括号在同一行。好：
if(...)
{//Dosomething
}
不好：
if(...){
//Dosomething
}
在每个运算符和括号的前后都空一格。.好：
if(showResult==true)
{
for(inti=0;i<10;i++)
{
//
}
}
不好：
if(showResult==true)
{
for(inti=0;i<10;i++)
{
//
}
}良好的编程习惯
遵从以下良好的习惯以写出好程序
避免使用大文件。如果一个文件里的代码超过300～400行，必须考虑将代码分开到不同类中。
避免写太长的方法。一个典型的方法代码在1～25行之间。如果一个方法发代码超过25行，应该考虑将其分解为不同的方法。
方法名需能看出它作什么。别使用会引起误解的名字。如果名字一目了然，就无需用文档来解释方法的功能了。好：
voidSavePhoneNumber(stringphoneNumber)
{
//Savethephonenumber.
}
不好：
//Thismethodwillsavethephonenumber.
voidSaveData(stringphoneNumber)
{
//Savethephonenumber.
}一个方法只完成一个任务。不要把多个任务组合到一个方法中，即使那些任务非常小。好：
//Savetheaddress.
Save