c#编程规范

http://download.csdn.net/source/171236

●1.  避免将多个类放在一个文件里面。  ●2.  一个文件应该只有一个命名空间,避免将多个命名空间放在同一个文件里面。 ●3.  一个文件最好不要超过500行的代码（不包括机器产生的代码）。 ●4.  一个方法的代码长度最好不要超过25行。 ●5.  避免方法中有超过5个参数的情况。使用结构来传递多个参数。 ●6.  每行代码不要超过80个字符。 ●7.  不要手工的修改机器产生的代码。 a)  如果需要编辑机器产生的代码，编辑格式和风格要符合该编码标准。 b)  Use partial classes whenever possible to factor out the maintained portions.  ●8.  避免利用注释解释显而易见的代码。 a)  代码应该可以自解释。好的代码由可读的变量和方法命名因此不需要注释。 ●9.  Document only operational assumptions, algorithm insights and so on.    ●10.  避免使用方法级的文档。 a)  使用扩展的API文档说明之。 b)  只有在该方法需要被其他的开发者使用的时候才使用方法级的注释。（在C#中就是///） ●11.  不要硬编码数字的值，总是使用构造函数设定其值。 ●12.  只有是自然结构才能直接使用const，比如一个星期的天数。 ●13.  避免在只读的变量上使用const。如果想实现只读，可以直接使用readonly。 public class MyClass
{
   public readonly int Number;
   public MyClass(int  someValue)
   {
      Number = someValue;
   }
   public  const int  DaysInWeek = 7;
}  ●14.  每个假设必须使用Assert检查 a)  平均每15行要有一次检查(Assert) using System.Diagnostics;
object GetObject()
{…}
object obj = GetObject();
Debug.Assert(obj != null);  ●15.  代码的每一行都应该通过白盒方式的测试。 ●16.  只抛出已经显示处理的异常。 ●17.  在捕获(catch)语句的抛出异常子句中(throw)，总是抛出原始异常维护原始错误的堆栈分配。 catch(Exception exception)
{
   MessageBox.Show(exception.Message);
   throw ;  //和throw exception一样。
}  ●18.  避免方法的返回值是错误代码。 ●19.  尽量避免定义自定义异常类。 ●20.  当需要定义自定义的异常时： a)  自定义异常要继承于ApplicationException。 b)  提供自定义的序列化功能。 ●21.  避免在单个程序集里使用多个Main方法。 ●22.  只对外公布必要的操作，其他的则为internal。 ●23.  Avoid friend assemblies, as it increases inter-assembly coupling. ●24.  Avoid code that relies on an assembly running from a particular location.  ●25.  使应用程序集尽量为最小化代码(EXE客户程序)。使用类库来替换包含的商务逻辑。 ●26.  避免给枚举变量提供显式的值。 //正确方法
public enum Color
{
   Red,Green,Blue
}
//避免
public enum Color
{
   Red = 1,Green =  2,Blue = 3
}  ●27.  避免指定特殊类型的枚举变量。 //避免
public enum Color  : long
{
   Red,Green,Blue
}  ●28.  即使if语句只有一句，也要将if语句的内容用大括号扩起来。 ●29.  避免使用trinary条件操作符。 ●30.  避免在条件语句中调用返回bool值的函数。可以使用局部变量并检查这些局部变量。 bool IsEverythingOK()
{…}
//避免
if (IsEverythingOK ())
{…}
//替换方案
bool ok = IsEverythingOK();
if (ok)
{…}  ●31.  总是使用基于0开始的数组。 ●32.  在循环中总是显式的初始化引用类型的数组。 public class MyClass
{}
MyClass[] array = new  MyClass[100];
for(int index = 0; index < array.Length;  index++)
{
   array[index] = new  MyClass();
}  ●33.  不要提供public 和 protected的成员变量，使用属性代替他们。 ●34.  避免在继承中使用new而使用override替换。 ●35.  在不是sealed的类中总是将public 和 protected的方法标记成virtual的。 ●36. 除非使用interop(COM+ 或其他的dll)代码否则不要使用不安全的代码(unsafe code)。 ●37. 避免显示的转换，使用as操作符进行兼容类型的转换。 Dog dog = new GermanShepherd();
GermanShepherd shepherd = dog as GermanShepherd;
if (shepherd != null )
{…}  ●38. 当类成员包括委托的时候 a) Copy a delegate to a local variable before publishing to avoid concurrency race
condition.  b) 在调用委托之前一定要检查它是否为null
public class MySource
{
public event EventHandler MyEvent;
public void FireEvent()
{
EventHandler temp = MyEvent;
if(temp != null )
{
temp(this,EventArgs.Empty);
}
}
}  ●39. 不要提供公共的事件成员变量，使用事件访问器替换这些变量。 public class MySource
{
MyDelegate m_SomeEvent ;
public event MyDelegate SomeEvent
{
add
{
m_SomeEvent += value;
}
remove
{
m_SomeEvent -= value;
}
}
}  ●40. 使用一个事件帮助类来公布事件的定义。  ●41. 总是使用接口。 ●42. 类和接口中的方法和属性至少为2:1的比例。 ●43. 避免一个接口中只有一个成员。 ●44. 尽量使每个接口中包含3－5个成员。 ●45. 接口中的成员不应该超过20个。 a) 实际情况可能限制为12个  ●46. 避免接口成员中包含事件。 ●47. 避免使用抽象方法而使用接口替换。 ●48. 在类层次中显示接口。 ●49. 推荐使用显式的接口实现。 ●50. 从不假设一个类型兼容一个接口。Defensively query for that interface. SomeType obj1;
IMyInterface obj2;
/* 假设已有代码初始化过obj1，接下来 */
obj2 = obj1 as IMyInterface;
if (obj2 != null)
{
obj2.Method1();
}
else
{
//处理错误
}  ●51. 表现给最终用户的字符串不要使用硬编码而要使用资源文件替换之。 ●52. 不要硬编码可能更改的基于配置的字符串，比如连接字符串。 ●53. 当需要构建长的字符串的时候，使用StringBuilder不要使用string ●54. 避免在结构里面提供方法。 a) 建议使用参数化构造函数 b) 可以重裁操作符 ●55. 总是要给静态变量提供静态构造函数。 ●56. 能使用早期绑定就不要使用后期绑定。 ●57. 使用应用程序的日志和跟踪。 ●58. 除非在不完全的switch语句中否则不要使用goto语句。 ●59. 在switch语句中总是要有default子句来显示信息(Assert)。 int number = SomeMethod();
switch(number)
{
case 1:
Trace.WriteLine("Case 1:");
break;
case 2:
Trace.WriteLine("Case 2:");
break;
default :
Debug.Assert(false);
break;
}  ●60. 除非在构造函数中调用其他构造函数否则不要使用this指针。 // 正确使用this的例子
public class MyClass
{
public MyClass(string message )
{}
public MyClass() : this("hello")
{}
}  ●61. 除非你想重写子类中存在名称冲突的成员或者调用基类的构造函数否则不要使用base来访问基类的成员。 // 正确使用base的例子
public class Dog
{
public Dog(string name)
{}
virtual public void Bark( int howLong)
{}
}
public class GermanShepherd : Dog
{
public GermanShe pherd(string name): base (name)
{}
override public void Bark(int howLong)
{
base .Bark(howLong);
}
}  ●62. 基于模板的时候要实现Dispose()和Finalize()两个方法。 ●63. 通常情况下避免有从System.Object转换来和由System.Object转换去的代码，而使用强制转换或者as操作符替换。 class SomeClass
{}
//避免：
class MyClass<T>
{
void SomeMethod(T t)
{
object temp = t;
SomeClass obj = (SomeClass)temp;
}
}
// 正确：
class MyClass<T> where T : SomeClass
{
void SomeMethod(T t)
{
SomeClass obj = t;
}
}  ●64. 在一般情况下不要定影有限制符的接口。接口的限制级别通常可以用强类型来替换之。 public class Customer
{…}
//避免：
public interface IList<T> where T : Customer
{…}
//正确：
public interface ICustomerList : IList<Customer>
{…}  ●65. 不确定在接口内的具体方法的限制条件。 ●66. 总是选择使用C#内置（一般的generics）的数据结构。

术语定义 Pascal 大小写将标识符的首字母和后面连接的每个单词的首字母都大写。可以对三字符或更多字符的标识符使用Pascal 大小写。例如：BackColor Camel 大小写标识符的首字母小写，而每个后面连接的单词的首字母都大写。例如：backColor
文件命名组织 1.3.1文件命名 1 文件名遵从Pascal命名法，无特殊情况，扩展名小写。
2 使用统一而又通用的文件扩展名： C# 类 .cs
1.3.2文件注释 1 在每个文件头必须包含以下注释说明
/*----------------------------------------------------------------
// Copyright (C) 2004 东软集团有限公司
// 版权所有。
//
// 文件名：
// 文件功能描述：
//
//
// 创建标识：
//
// 修改标识：
// 修改描述：
//
// 修改标识：
// 修改描述：
//----------------------------------------------------------------*/文件功能描述只需简述，具体详情在类的注释中描述。
创建标识和修改标识由创建或修改人员的拼音或英文名加日期组成。如：李轶20040408 一天内有多个修改的只需做一个在注释说明中做一个修改标识就够了。
在所有的代码修改处加上修改标识的注释。详见下边链接http://www.cnblogs.com/zyh-nhy/archive/2007/10/11/921250.html

C#编程规范
  Version 2.0
目录
第一章　概述 4
规范制定原则 4
术语定义 4
Pascal 大小写 4
Camel 大小写 4
文件命名组织 4
1.3.1文件命名 4
1.3.2文件注释 4
第二章   代码外观 6
2.1 列宽 6
2.2 换行 6
2.3 缩进 6
2.4 空行 6
2.5 空格 6
2.6 括号 - () 7
2.7 花括号 - {} 7
第三章程序注释 9
3.4 注释概述 9
3.2 文档型注释 9
3.3 类C注释 10
3.4 单行注释 10
3.5 注释标签 10
第四章　申明 14
4.1 每行声明数 14
4.2 初始化 14
4.3 位置 14
4.4 类和接口的声明 15
4.5 字段的声明 15
第五章　命名规范 16
5.1 命名概述 16
5.2 大小写规则 16
5.3 缩写 17
5.4 命名空间 17
5.5 类 18
5.6 接口 18
5.7 属性 (ATTRIBUTE) 19
5.8 枚举 (ENUM) 19
5.9 参数 19
5.10 方法 20
5.11 属性 (PROPERTY) 20
5.12 事件 21
5.13 常量 (CONST) 22
5.14 字段 23
5.15 静态字段 23
5.16 集合 24
5.17 措词 24
第六章　语句 26
6.1 每行一个语句 26
6.2 复合语句 26
6.3 RETURN 语句 26
6.4 IF、 IF-ELSE、IF ELSE-IF 语句 26
6.4   FOR、FOREACH 语句 27
6.5 WHILE 语句 27
6.7. DO - WHILE 语句 28
6.8. SWITCH - CASE 语句 28
6.9. TRY - CATCH 语句 28
6.10. USING 块语句 29
6.11. GOTO 语句 29
第七章控件命名规则 30
7.1 命名方法 30
7.2 主要控件名简写对照表 30
第八章其他 30
8.1 表达式 30
8.2 类型转换 30
附录一: 匈牙利命名法 31 第一章　概述规范制定原则
1 方便代码的交流和维护。
   2 不影响编码的效率，不与大众习惯冲突。
   3 使代码更美观、阅读更方便。
   4 使代码的逻辑更清晰、更易于理解。术语定义
Pascal 大小写
      将标识符的首字母和后面连接的每个单词的首字母都大写。可以对三字符或更多字符的标识符使用Pascal 大小写。例如：
               BackColor
Camel 大小写
标识符的首字母小写，而每个后面连接的单词的首字母都大写。例如：
                backColor文件命名组织
1.3.1文件命名
1 文件名遵从Pascal命名法，无特殊情况，扩展名小写。
2 使用统一而又通用的文件扩展名： C# 类  .cs
1.3.2文件注释
  1 在每个文件头必须包含以下注释说明
            /*----------------------------------------------------------------
            // Copyright (C) 2004 东软集团有限公司
            // 版权所有。
            //
            // 文件名：
            // 文件功能描述：
            //
            //
            // 创建标识：
            //
            // 修改标识：
            // 修改描述：
            //
            // 修改标识：
            // 修改描述：
//----------------------------------------------------------------*/文件功能描述只需简述，具体详情在类的注释中描述。
创建标识和修改标识由创建或修改人员的拼音或英文名加日期组成。如：    Edit by Rose 20040408一天内有多个修改的只需做一个在注释说明中做一个修改标识就够了。
在所有的代码修改处加上修改标识的注释。
第二章   代码外观2.1 列宽
    代码列宽控制在110字符左右。2.2 换行
      当表达式超出或即将超出规定的列宽，遵循以下规则进行换行
          1、在逗号后换行。
          2、在操作符前换行。
          3、规则1优先于规则2。
     当以上规则会导致代码混乱的时候自己采取更灵活的换行规则。


2.3 缩进
     缩进应该是每行一个Tab(4个空格)，不要在代码中使用Tab字符。
  Visual Studio.Net设置：工具->选项->文本编辑器->C#->制表符->插入空格2.4 空行
空行是为了将逻辑上相关联的代码分块，以便提高代码的可阅读性。
    在以下情况下使用两个空行
    1、接口和类的定义之间。
    2、枚举和类的定义之间。
    3、类与类的定义之间。

    在以下情况下使用一个空行
         1、方法与方法、属性与属性之间。
         2、方法中变量声明与语句之间。
         3、方法与方法之间。
         4、方法中不同的逻辑块之间。
      　 5、方法中的返回语句与其他的语句之间。
         6、属性与方法、属性与字段、方法与字段之间。
         7、注释与它注释的语句间不空行，但与其他的语句间空一行。2.5 空格
在以下情况中要使用到空格
        1、关键字和左括符 “(” 应该用空格隔开。如           while (true)               注意在方法名和左括符 “(” 之间不要使用空格，这样有助于辨认代码中的方法调用与关键字。

2、多个参数用逗号隔开，每个逗号后都应加一个空格。
3、除了 . 之外，所有的二元操作符都应用空格与它们的操作数隔开。一元操作符、++及--与操作    数间不需要空格。如                     a  +=  c  +  d;
                   a  =  (a  +  b)   /   (c  *  d);
                while  (d++  =  s++)
                {
                    n++;
                }
                PrintSize(“size is “  +  size  +  “\n”);4、语句中的表达式之间用空格隔开。如       for  (expr1;  expr2;  expr3)2.6 括号 - ()
      1、左括号“(” 不要紧靠关键字，中间用一个空格隔开。
      2、左括号“(”  与方法名之间不要添加任何空格。
      3、没有必要的话不要在返回语句中使用()。如

        if (condition)            Array.Remove(1)            return 1  2.7 花括号 - {}
       1、左花括号 “{” 放于关键字或方法名的下一行并与之对齐。如             if (condition)
             {
             }             public int Add(int x, int y)
             {
             }                           2、左花括号 “{” 要与相应的右花括号 “}”对齐。
       3、通常情况下左花括号 “{”单独成行，不与任何语句并列一行。
       4、 if、while、do语句后一定要使用{}，即使{}号中为空或只有一条语句。如             if (somevalue == 1)
             {
                 somevalue = 2;
             }5、右花括号 “}” 后建议加一个注释以便于方便的找到与之相应的 {。如               while  (1)
               {
                   if  (valid)
                   {
                   } // if valid
                   else
                   {
                   } // not valid
                } // end forever
第三章程序注释
3.4 注释概述
1、修改代码时，总是使代码周围的注释保持最新。
2、在每个例程的开始，提供标准的注释样本以指示例程的用途、假设和限制很有帮助。注释样本应该是解释它为什么存在和可以做什么的简短介绍.
3、避免在代码行的末尾添加注释；行尾注释使代码更难阅读。不过在批注变量声明时，行尾注释是合适的；在这种情况下，将所有行尾注释在公共制表位处对齐。
4 、避免杂乱的注释，如一整行星号。而是应该使用空白将注释同代码分开。
5 、避免在块注释的周围加上印刷框。这样看起来可能很漂亮，但是难于维护。
6 、在部署发布之前，移除所有临时或无关的注释，以避免在日后的维护工作中产生混乱。
7 、如果需要用注释来解释复杂的代码节，请检查此代码以确定是否应该重写它。尽一切可能不注释难以理解的代码，而应该重写它。尽管一般不应该为了使代码更简单以便于人们使用而牺牲性能，但必须保持性能和可维护性之间的平衡。
8 、在编写注释时使用完整的句子。注释应该阐明代码，而不应该增加多义性。
9 、在编写代码时就注释，因为以后很可能没有时间这样做。另外，如果有机会复查已编写的代码，在今天看来很明显的东西六周以后或许就不明显了。
10 、避免多余的或不适当的注释，如幽默的不主要的备注。
11、使用注释来解释代码的意图。它们不应作为代码的联机翻译。
12、注释代码中不十分明显的任何内容。
13 、为了防止问题反复出现，对错误修复和解决方法代码总是使用注释，尤其是在团队环境中。
14 、对由循环和逻辑分支组成的代码使用注释。这些是帮助源代码读者的主要方面。
15 、在整个应用程序中，使用具有一致的标点和结构的统一样式来构造注释。
16 、用空白将注释同注释分隔符分开。在没有颜色提示的情况下查看注释时，这样做会使注释很明显且容易被找到。
17 、在所有的代码修改处加上修改标识的注释。
18 、为了是层次清晰，在闭合的右花括号后注释该闭合所对应的起点。
    namespace Langchao.Procument.Web
{
} // namespace Langchao.Procument.Web
3.2 文档型注释
该类注释采用.Net已定义好的Xml标签来标记，在声明接口、类、方法、属性、字段都应该使用该类注释，以便代码完成后直接生成代码文档，让别人更好的了解代码的实现和接口。如///<summary>MyMethod is a method in the MyClass class.
///<para>Here's how you could make a second paragraph in a description.
///<see cref="System.Console.WriteLine"/>
///for information about output statements.
///</para>
            ///<seealso cref="MyClass.Main"/>
            ///</summary>
   public static void MyMethod(int Int1)

解决方案 »