C#编程规范（整理）[转]
1.命名惯例和规范
注记 :
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;
...
}
}
Ø 根据类的具体情况进行合理的命名
以Class声明的类，都必须以名词或名词短语命名，体现类的作用。如：
Class Indicator
当类只需有一个对象实例（全局对象，比如Application等），必须以Class结尾，如
Class ScreenClass
Class SystemClass
当类只用于作为其他类的基类，根据情况，以Base结尾：
Class IndicatorBase
Ø 不要使用匈牙利方法来命名变量
以前，多数程序员喜欢它－把数据类型作为变量名的前缀而m_作为成员变量的前缀。例如：
string m_sName; int nAge;
然而，这种方式在.NET编码规范中是不推荐的。所有变量都用camel 大小写形式，而不是用数据类型和m_来作前缀。
Ø 控件命名
建议是使用控件名简写作为前缀，并且简写的首字母小写，符合Camel规范。
格式：控件名简写+英文描述，英文描述首字母大写
主要控件名简写对照表
Label lbl
TextBox txt
Button btn
CheckBox chk
RadioButton rdo
CheckBoxList chklst
RadioButtonList rdolst
ListBox lst
DropDownList ddl
DataGrid dg
DataList dl
Image img
Table tbl
Panel pnl
LinkButton lnkbtn
ImageButton imgbtn
Calender cld
AdRotator ar
RequiredFieldValidator rfv
CompareValidator cv
RangeValidator rv
RegularExpressionValidator rev
ValidatorSummary vs
CrystalReportViewer rptvew
Ø 用有意义的，描述性的词语来命名变量
别用缩写。用name, address, salary等代替 nam, addr, sal
别使用单个字母的变量象i, n, x 等. 使用 index, temp等
用于循环迭代的变量例外：
for ( int i = 0; i < count; i++ ){ ...}
如果变量只用于迭代计数，没有在循环的其他地方出现，许多人还是喜欢用单个字母的变量(i) ，而不是另外取名。
变量名中不使用下划线 (_) 。
Ø 文件名要和类名匹配
例如，对于类HelloWorld, 相应的文件名应为 HelloWorld.cs (或, HelloWorld.vb)
2.良好的编程习惯
遵从以下良好的习惯以写出好程序
1) 避免使用大文件。如果一个文件里的代码超过300～400行，必须考虑将代码分开到不同类中。
2) 避免写太长的方法。一个典型的方法代码在1～25行之间。如果一个方法发代码超过25行，应该考虑将其分解为不同的方法。
3) 方法名需能看出它作什么。别使用会引起误解的名字。如果名字一目了然，就无需用文档来解释方法的功能了。
好：
void SavePhoneNumber ( string phoneNumber ) { // Save the phone number. }
不好：
// This method will save the phone number.
void SaveData ( string phoneNumber ) { // Save the phone number. }
4) 一个方法只完成一个任务。不要把多个任务组合到一个方法中，即使那些任务非常小。
5) 使用C# 或 VB.NET的特有类型，而不是System命名空间中定义的别名类型。（为什么）
好： int age; string name; object contactInfo;
不好： Int16 age; String name; Object contactInfo;
6) 别在程序中使用固定数值，用常量代替。
7) 别用字符串常数。用资源文件。（为什么）
8) 必要时使用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;
}
}
9) 别把成员变量声明为 public 或 protected。都声明为 private 而使用 public/protected 的Properties. 而且，成员变量前缀为“_”。
10) 不在代码中使用具体的路径和驱动器名。 使用相对路径，并使路径可编程。
永远别设想你的代码是在“C:”盘运行。你不会知道，一些用户在网络或“Z:”盘运行程序。
11) 人性化消息提示。
错误消息需能帮助用户解决问题。永远别用象"应用程序出错", "发现一个错误" 等错误消息。而应给出象 "更新数据库失败。请确保登陆id和密码正确。" 的具体消息。
显示错误消息时，除了说哪里错了，还应提示用户如何解决问题。不要用 象 "更新数据库失败。"这样的，要提示用户怎么做："更新数据库失败。请确保登陆id和密码正确。"
显示给用户的消息要简短而友好。但要把所有可能的信息都记录下来，以助诊断问题。
12）多使用StringBuilder替代String
String对象是不可改变的。每次使用System.String类中的方法之一时，都要在内存中创建一个新的字符串对象，这就需要为该新对象分配新的空间。在需要对字符串执行重复修改的情况下，与创建新的String对象相关的系统开销可能会非常昂贵。如果要修改字符串而不创建新的对象，则可以使用System.Text.StringBuilder类。例如，当在一个循环中将许多字符串连接在一起时，使用StringBuilder类可以提升性能。
以下方法常用于修改StringBuilder的内容。
StringBuilder.Append 将信息追加到当前StringBuilder的结尾。
StringBuilder.AppendFormat 用带格式文本替换字符串中传递的格式说明符。
StringBuilder.Insert 将字符串或对象插入到当前StringBuilder对象的指定索引处。
StringBuilder.Remove 从当前StringBuilder对象中移除指定数量的字符。
StringBuilder.Replace 替换指定索引处的指定字符。
3.注释
Ø 文件头部注释
在代码文件的头部进行注释，标注出创始人、创始时间、修改人、修改时间、代码的功能，这在团队开发中必不可少，它们可以使后来维护/修改的同伴在遇到问题时，在第一时间知道他应该向谁去寻求帮助，并且知道这个文件经历了多少次迭代、经历了多少个程序员的手。
样本：
/********************************************************************************
** 作者： Eunge
** 创始时间：2004-6-8
** 修改人：Koffer
** 修改时间：2004-12-9
** 修改人：Ken
** 修改时间：2005-01-29
** 描述：
** 主要用于产品信息的资料录入，…
*********************************************************************************/
我们甚至可以在这段文件头注释中加入版权信息、文件名、版本信息等。
Ø 函数、属性、类等注释 （可扩充）
请使用///三斜线注释，这种注释是基于XML的，不仅能导出XML制作帮助文档，而且在各个函数、属性、类等的使用中，编辑环境会自动带出注释，方便你的开发。以protected，protected Internal，public声明的定义注释请都以这样命名方法。
例如：
/// <summary>
/// 用于从ERP系统中捞出产品信息的类
/// </summary>
class ProductTypeCollector
{
…
}
Ø 逻辑点注释
在我们认为逻辑性较强的地方加入注释，说明这段程序的逻辑是怎样的，以方便我们自己后来的理解以及其他人的理解，并且这样还可以在一定程度上排除BUG。在注释中写明我们的逻辑思想，对照程序，判断程序是否符合我们的初衷，
如果不是，则我们应该仔细思考修改的是注释还是程序了。（有些深奥）
4.异常处理（*供参考）
什么时候用Try catch?
什么时候用Finally?
1) 数据库操作
2) 文件操作
不要“捕捉了异常却什么也不做“。如果隐藏了一个异常，你将永远不知道异常到底发生了没有。
发生异常时，给出友好的消息给用户，但要精确记录错误的所有可能细节，包括发生的时间，和相关方法，类名等。
只捕捉特定的异常，而不是一般的异常。
好：
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.
// 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。
