软件工程项目组代码规范

1 代码格式

• 全部的缩进为4个空格，使用VS.NET的默认设置。
• 在代码中垂直对齐左括号和右括号。

　　　　if(x==0)

     　　{

          　　Response.Write("用户编号必须输入！");

     　　}

        不容许如下状况：

　　　　if(x==0) {

              Response.Write("用户编号必须输入！");

     　　}

　　　或者：

　　　　if(x==0){ Response.Write("用户编号必须输入！");}

• 每一行上放置的语句避免超过一条。
• 在大多数运算符以前和以后使用空格，这样作时不会改变代码的意图却可使代码容易阅读。

　　例：

         int j = i + k; 

　　而不该写为

    　　int j=i+k;

• 代码整理可使用快捷键Ctrl+K+F

2 命名指南

2.1 大写样式

　　使用下面的三种大写标识符约定。

　　Pascal 大小写

　　将标识符的首字母和后面链接的每一个单词的首字母都大写。能够对三字符或更多字符的标识符使用 Pascal 大小写。例如：

　　BackColor

　　Camel 大小写

　　标识符的首字母小写，而每一个后面链接的单词的首字母都大写。例如：

　　backColor

　　大写

　　标识符中的全部字母都大写。仅对于由两个或者更少字母组成的标识符使用该约定。例如：

　　System.IO

　　System.Web.UI

　　可能还必须大写标识符以维持与现有非托管符号方案的兼容性，在该方案中全部大写字母常常用于枚举和常数值。通常状况下，在使用它们的程序集以外这些字符应当是不可见的。

　　下表汇总了大写规则，并提供了不一样类型的标识符的示例。

 

标识符	大小写	示例
类	Pascal	AppDomain
枚举类型	Pascal	ErrorLevel
枚举值	Pascal	FatalError
事件	Pascal	ValueChange
异常类	Pascal	WebException 注意 老是以 Exception 后缀结尾。
只读的静态字段	Pascal	RedValue
接口	Pascal	IDisposable 注意 老是以 I 前缀开始。
方法	Pascal	ToString
命名空间	Pascal	System.Drawing
参数	Camel	typeName
属性	Pascal	BackColor
受保护的实例字段	Camel	redValue 注意 不多使用。属性优于使用受保护的实例字段。
公共实例字段	Pascal	RedValue 注意 不多使用。属性优于使用公共实例字段。

2.2 区分大小写

　　为了不混淆和保证跨语言交互操做，请遵循有关区分大小写的使用的下列规则：

• 不要使用要求区分大小写的名称。对于区分大小写和不区分大小写的语言，组件都必须彻底可使用。不区分大小写的语言没法区分同一上下文中仅大小写不一样的两个名称。所以，在建立的组件或类中必须避免这种状况。
• 不要建立仅是名称大小写有区别的两个命名空间。例如，不区分大小写的语言没法区分如下两个命名空间声明。

　　namespace ee.cummings;

　　namespace Ee.Cummings;

•  不要建立具备仅是大小写有区别的参数名称的函数。下面的示例是不正确的。

　　void MyFunction(string a, string A)

•  不要建立具备仅是大小写有区别的类型名称的命名空间。在下面的示例中，Point p 和 POINT p 是不适当的类型名称，缘由是它们仅是大小写有区别。

　　System.Windows.Forms.Point p

　　System.Windows.Forms.POINT p

• 不要建立具备仅是大小写有区别的属性名称的类型。在下面的示例中，int Color 和 int COLOR 是不适当的属性名称，缘由是它们仅是大小写有区别。

　　int Color {get, set}

　　int COLOR {get, set}

• 不要建立具备仅是大小写有区别的方法名称的类型。在下面的示例中，calculate 和 Calculate 是不适当的方法名称，缘由是它们仅是大小写有区别。

　　void calculate()

　　void Calculate()

2.3 缩写

　　为了不混淆和保证跨语言交互操做，请遵循有关区缩写的使用的下列规则：

• 不要将缩写或缩略形式用做标识符名称的组成部分。例如，使用 GetWindow，而不要使用 GetWin。
• 不要使用计算机领域中未被广泛接受的缩写。
• 在适当的时候，使用众所周知的缩写替换冗长的词组名称。例如，用 UI 做为 User Interface 的缩写，用 OLAP 做为 On-line Analytical Processing 的缩写。
• 在使用缩写时，对于超过两个字符长度的缩写请使用 Pascal 大小写或 Camel 大小写。例如，使用 HtmlButton 或 HTMLButton。可是，应当大写仅有两个字符的缩写，如，System.IO，而不是 System.Io。
• 不要在标识符或参数名称中使用缩写。若是必须使用缩写，对于由多于两个字符所组成的缩写请使用 Camel 大小写，虽然这和单词的标准缩写相冲突。
• 特别针对程序设计中组件设计内容较多，对于组件缩写命名遵循如下规则：

组件类型	缩写	例子
Label	Lbl	lblNote
TextBox	Txt	txtName
Button	Btn	btnOK
ImageButton	Ib	ibOK
LinkButton	Lb	lbJump
HyperLink	Hl	hlJump
DropDownList	Ddl	ddlList
CheckBox	Cb	cbChoice
CheckBoxList	Cbl	cblGroup
RadioButton	Rb	rbChoice
RadioButtonList	Rbl	rblGroup
Image	Img	imgBeauty
Panel	Pnl	pnlTree
TreeView	Tv	tvUnit
WebComTable	Wct	wctBasic
ImageDateTimeInput	Dti	dtiStart
ComboBox	Cb	cbList
MyImageButton	Mib	mibOK
WebComm.TreeView	Tv	tvUnit
PageBar	Pb	pbMaster

2.4 命名空间的命名

　　命名命名空间时的通常性规则是使用公司名称，后跟技术名称和可选的功能与设计，以下所示。

　　CompanyName.TechnologyName[.Feature][.Design]

　　例如：

　　Microsoft.Media

　　Microsoft.Media.Design

　　给命名空间名称加上公司名称或者其余知名商标的前缀能够避免两个已经发布的命名空间名称相同的可能性。例如，Microsoft.Office 是由 Microsoft 提供的 Office Automation Classes 的一个适当的前缀。

　　在第二级分层名称上使用稳定的、公认的技术名称。将组织层次架构用做命名空间层次架构的基础。命名一个命名空间，该命名空间包含为具备 .Design 后缀的基命名空间提供设计时功能的类型。例如，System.Windows.Forms.Design 命名空间包含用于设计基于 System.Windows.Forms 的应用程序的设计器和相关的类。

　　嵌套的命名空间应当在包含它的命名空间中的类型上有依赖项。例如，System.Web.UI.Design 中的类依赖于 System.Web.UI 中的类。可是，System.Web.UI 中的类不依赖于 System.UI.Design 中的类。

　　应当对命名空间使用 Pascal 大小写，并用句点分隔逻辑组件，如 Microsoft.Office.PowerPoint 中所示。若是您的商标使用非传统的大小写，请遵循您的商标所定义的大小写，即便它与规定的 Pascal 大小写相背离。例如，命名空间 NeXT.WebObjects 和 ee.cummings 阐释了对于 Pascal 大小写规则的适当背离。

　　若是在语义上适当，使用复数命名空间名称。例如，使用 System.Collections而不是 System.Collection。此规则的例外是商标名称和缩写。例如，使用 System.IO而不是 System.IOs。

　　不要为命名空间和类使用相同的名称。例如，不要既提供 Debug 命名空间也提供 Debug 类。

　　最后，请注意命名空间名称没必要非得与程序集名称类似。例如，若是命名程序集 MyCompany.MyTechnology.dll，它没有必要非得包含 MyCompany.MyTechnology 命名空间。

2.5 类命名

　　如下规则概述命名类：

• 使用名词或名词短语命名类。
• 使用 Pascal 大小写。
• 少用缩写。
• 不要使用类型前缀，如在类名称上对类使用 C 前缀。例如，使用类名称 FileStream，而不是 CFileStream。
• 不要使用下划线字符 (_)。
• 有时候须要提供以字母 I 开始的类名称，虽然该类不是接口。只要 I 是做为类名称组成部分的整个单词的第一个字母，这即是适当的。例如，类名称 IdentityStore 是适当的。
• 在适当的地方，使用复合单词命名派生的类。派生类名称的第二个部分应当是基类的名称。例如，ApplicationException 对于从名为 Exception 的类派生的类是适当的名称，缘由是 ApplicationException 是一种 Exception。请在应用该规则时进行合理的判断。例如，Button 对于从 Control 派生的类是适当的名称。尽管按钮是一种控件，可是将 Control 做为类名称的一部分将使名称没必要要地加长。

　　下面是正确命名的类的示例。

　　[Visual Basic]

　　Public Class FileStream

　　Public Class Button

　　Public Class String

　　[C#]

　　public class FileStream

　　public class Button

　　public class String

2.6 类成员变量命名

       类成员变量加 m_ 前缀，如： int m_ContentLength。

2.7 接口命名

　　如下规则概述接口的命名：

• 用名词或名词短语，或者描述行为的形容词命名接口。例如，接口名称 IComponent 使用描述性名词。接口名称 ICustomAttributeProvider 使用名词短语。名称 IPersistable 使用形容词。
• 使用 Pascal 大小写。
• 少用缩写。
• 给接口名称加上字母 I 前缀，以指示该类型为接口。
• 在定义类/接口对（其中类是接口的标准实现）时使用类似的名称。两个名称的区别应该只是接口名称上有字母 I 前缀。
• 不要使用下划线字符 (_)。

　　如下是正确命名的接口的示例。

　　[Visual Basic]

　　Public Interface IServiceProvider

　　Public Interface IFormatable

　　[C#]

　　public interface IServiceProvider

　　public interface IFormatable

　　如下代码示例阐释如何定义 IComponent 接口及其标准实现 Component 类。

　　[Visual Basic]

　　Public Interface IComponent

  　　 ' Implementation code goes here.

　　End Interface

 

　　Public Class Component

   　　Implements IComponent

   　　' Implementation code goes here.

　　End Class

　　[C#]

　　public interface IComponent

　　{

 

　　}

　　public class Component: IComponent

　　{

  　　// Implementation code goes here.

　　}

2.8 枚举类型命名

　　枚举 (Enum) 值类型从 Enum 类继承。如下规则概述枚举的命名指南：

• 对于 Enum 类型和值名称使用 Pascal 大小写。
• 少用缩写。
• 不要在 Enum 类型名称上使用 Enum 后缀。
• 对大多数 Enum 类型使用单数名称，可是对做为位域的 Enum 类型使用复数名称。
• 老是将 FlagsAttribute 添加到位域 Enum 类型。

2.9 静态字段命名

　　如下规则概述静态字段的命名：

• 使用名词、名词短语或者名词的缩写命名静态字段。
• 使用 Pascal 大小写。
• 对静态字段名称使用匈牙利语表示法前缀。
• 建议尽量使用静态属性而不是公共静态字段。

2.10 参数命名

　　如下规则概述参数的命名：

• 使用描述性参数名称。参数名称应当具备足够的描述性，以便参数的名称及其类型可用于在大多数状况下肯定它的含义。
• 对参数名称使用 Camel 大小写。
• 使用描述参数的含义的名称，而不要使用描述参数的类型的名称。开发工具将提供有关参数的类型的有意义的信息。所以，经过描述意义，能够更好地使用参数的名称。少用基于类型的参数名称，仅在适合使用它们的地方使用它们。
• 不要使用保留的参数。保留的参数是专用参数，若是须要，能够在将来的版本中公开它们。相反，若是在类库的将来版本中须要更多的数据，请为方法添加新的重载。
• 不要给参数名称加匈牙利语类型表示法的前缀。

　　如下是正确命名的参数的示例。

　　[Visual Basic]

　　GetType(typeName As String)As Type

　　Format(format As String, object [] args)As String

　　[C#]

　　Type GetType(string typeName)

　　string Format(string format, args() As object)

2.11 方法命名

　　如下规则概述方法的命名：

• 使用动词或动词短语命名方法。
• 使用 Pascal 大小写。

　　如下是正确命名的方法的实例。

　　RemoveAll()

　　GetCharArray()

　　Invoke()

2.12 属性命名

　　如下规则概述属性的命名：

• 使用名词或名词短语命名属性。
• 使用 Pascal 大小写。
• 不要使用匈牙利语表示法。
• 考虑用与属性的基础类型相同的名称建立属性。例如，若是声明名为 Color 的属性，则属性的类型一样应该是 Color。请参阅本主题中后面的示例。

　　如下代码示例阐释正确的属性命名。

　　[Visual Basic]

　　Public Class SampleClass

   　　Public Property BackColor As Color

      　　' Code for Get and Set accessors goes here.

   　　End Property

　　End Class

　　[C#]

　　public class SampleClass

　　{

   　　public Color BackColor

   　　{

     　　 // Code for Get and Set accessors goes here.

   　　}

　　}

　　如下代码示例阐释提供其名称与类型相同的属性。

　　[Visual Basic]

　　Public Enum Color

  　　 ' Insert code for Enum here.

　　End Enum

　　Public Class Control

  　　 Public Property Color As Color

      　　Get

        　　 ' Insert code here.

     　　 End Get

      　　Set

         　　' Insert code here.

     　　 End Set

   　　End Property

　　End Class

　　[C#]

　　public enum Color

　　{

 　　  // Insert code for Enum here.

　　}

　　public class Control

　　{

   　　public Color Color

   　　{

     　　 get {// Insert code here.}

     　　 set {// Insert code here.}

  　　 }

　　}

　　如下代码示例不正确，缘由是 Color 属性是 Integer 类型的。

　　[Visual Basic]

　　Public Enum Color

  　　 ' Insert code for Enum here.

　　End Enum

　　Public Class Control

   　　Public Property Color As Integer

     　　 Get

      　　   ' Insert code here.

     　　 End Get

    　　  Set

    　　     ' Insert code here.

     　　 End Set

   　　End Property

　　End Class

　　[C#]

　　public enum Color {// Insert code for Enum here.}

　　public class Control

　　{

   　　public int Color

   　　{

     　　 get {// Insert code here.}

     　　 set {// Insert code here.} 

   　　}

　　}

　　在不正确的示例中，不可能引用 Color 枚举的成员。Color.Xxx 将被解释为访问一个成员，该成员首先获取 Color 属性（在 Visual Basic 中为 Integer 类型，在 C# 中为 int 类型）的值，而后再访问该值的某个成员（该成员必须是 System.Int32 的实例成员）。

2.13事件命名

　　如下规则概述事件的命名：

• 对事件处理程序名称使用 EventHandler 后缀。
• 指定两个名为 sender 和 e 的参数。sender 参数表示引起事件的对象。sender 参数始终是 object 类型的，即便在可使用更为特定的类型时也如此。与事件相关联的状态封装在名为 e 的事件类的实例中。对 e 参数类型使用适当而特定的事件类。
• 用 EventArgs 后缀命名事件参数类。
• 考虑用动词命名事件。
• 使用动名词（动词的“ing”形式）建立表示事件前的概念的事件名称，用过去式表示事件后。例如，能够取消的 Close 事件应当具备 Closing 事件和 Closed 事件。不要使用 BeforeXxx/AfterXxx 命名模式。
• 不要在类型的事件声明上使用前缀或者后缀。例如，使用 Close，而不要使用 OnClose。
• 一般状况下，对于能够在派生类中重写的事件，应在类型上提供一个受保护的方法（称为 OnXxx）。此方法只应具备事件参数 e，由于发送方老是类型的实例。

　　如下示例阐释具备适当名称和参数的事件处理程序。

　　public delegate void MouseEventHandler(object sender, MouseEventArgs e); [Visual Basic]

　　Public Delegate Sub MouseEventHandler(sender As Object, e As MouseEventArgs)

　　阐释正确命名的事件参数类。

　　[Visual Basic]

　　Public Class MouseEventArgs

   　　Inherits EventArgs

   　　Dim x As Integer

   　　Dim y As Integer

 

   　　Public Sub New MouseEventArgs(x As Integer, y As Integer)

     　　 me.x = x

     　　 me.y = y

   　　End Sub

     

  　　Public Property X As Integer

     　　 Get

        　　 Return x

     　　 End Get

  　　 End Property

     

   　　Public Property Y As Integer

      　　Get

        　　 Return y

     　　 End Get

  　　 End Property

　　End Class

　　[C#]

　　public class MouseEventArgs : EventArgs

　　{

   　　int x;

   　　int y;

   　　public MouseEventArgs(int x, int y)

    　　  { this.x = x; this.y = y; }

   　　public int X { get { return x; } }

   　　public int Y { get { return y; } }

　　}

3    注释（Comment）规范

　　注释规范包括：模块（类）注释规范、类的属性、方法注释规范、代码间注释

3.1  模块（类）注释规范

　　模块开始必须以如下形式书写模块注释：

　　　 ///<summary>

         ///模块编号：<模块编号，能够引用系统设计中的模块编号>

         ///做用：<对此类的描述，能够引用系统设计中的描述>

         ///做者：做者中文名

         ///编写日期：<模块建立日期，格式：YYYY-MM-DD>

         ///</summary>

　　若是模块有修改，则每次修改必须添加如下注释：

         ///<summary>

         ///Log编号：<Log编号,从1开始一次增长>

         ///修改描述：<对此修改的描述>

         ///做者：修改者中文名

         ///修改日期：<模块修改日期，格式：YYYY-MM-DD>

         ///</summary>

 3.2 类属性注释规范

　　在类的属性必须以如下格式编写属性注释：

         /// <summary>

         ///属性说明

　　   /// </summary>

3.3 方法注释规范

　　在类的方法声明前必须以如下格式编写注释

         /// <summary>

         /// 说明：<对该方法的说明>

         /// </summary>

         /// <param name="<参数名称>"><参数说明></param>

　　   /// <param name="<参数名称>"><参数说明></param>

         /// <returns>

         ///<对方法返回值的说明，该说明必须明确说明返回的值表明什么含义>

         /// </returns>

3.4 代码间注释规范

　　代码间注释分为单行注释和多行注释：

       单行注释：

　　　　//<单行注释>

       多行注释：

         /*多行注释1

          多行注释2

          多行注释3*/

　　代码中遇到语句块时必须添加注释（if,for,foreach,……）,添加的注释必须可以说明此语句块的做用和实现手段（所用算法等等）。

4 异常处理

　　异常的思想是只对错误采用异常处理：逻辑和编程错误，设置错误，被破坏的数据，资源耗尽，等等。一般的法则是系统在正常状态下以及无重载和硬件失效状态下，不该产生任何异常。

• 异常处理时能够采用适当的日志机制来报告异常，包括异常发生的时刻；
• 通常状况下不要使用异常实现来控制程序流程结构；
• 使用异常而不要用错误代码来报告错误；
• 要经过抛出异常的方式来报告操做失败；
• 若是成员没法成功地完成它应该作的任务，那么应该抛出异常；

4.1 异常类型选择规范

• 优先考虑使用System命名空间中已有的异常，而不是本身建立新的异常类型；
• 要使用最合理，最具针对性的异常。例如，对参数为空，应抛出 System.ArgutmentNullException，而不是System.ArgutmentException

4.2 异常处理规范

• 不是百分之百肯定的状况，不要吞掉异常；
• 建议捕获特定类型的异常，若是理解该异常在具体环境当中产生的缘由；
• 不要捕获不该该捕获的异常，一般应该容许异常沿着调用栈传递；
• 进行清理工做时要用try-finally，避免使用try-catch；
• 要在捕获并从新抛出异常时使用空的throw语句，这是保持调用栈的最好方法