一、概述

1.1 規(guī)范制定原則

 1 方便代碼的交流和維護(hù)。

   2 不影響編碼的效率，不與大眾習(xí)慣沖突。

   3 使代碼更美觀、閱讀更方便。

   4 使代碼的邏輯更清晰、更易于理解。

2.1 術(shù)語(yǔ)定義

Pascal 大小寫(xiě)

      將標(biāo)識(shí)符的首字母和后面連接的每個(gè)單詞的首字母都大寫(xiě)。可以對(duì)三字符或更多字符的標(biāo)識(shí)符使用Pascal 大小寫(xiě)。例如：

               BackColor

Camel 大小寫(xiě)

標(biāo)識(shí)符的首字母小寫(xiě)，而每個(gè)后面連接的單詞的首字母都大寫(xiě)。例如：

                backColor

二、注釋規(guī)范

2.1文件注釋

  1 在每個(gè)文件頭必須包含以下注釋說(shuō)明

            /*----------------------------------------------------------------

            // Copyright (C) 2007 團(tuán)隊(duì)名

            // 版權(quán)所有。

            // 開(kāi)發(fā)者：

            // 文件名：

            // 文件功能描述：

//----------------------------------------------------------------*/

2.2. 文檔型注釋

 該類注釋采用.Net已定義好的Xml標(biāo)簽來(lái)標(biāo)記如：

///<summary>

///方法說(shuō)明

///</summary>

///<para name="Int1">參數(shù)說(shuō)明</para>            

   public static void MyMethod(int Int1)

   {

           }

下表匯總了大寫(xiě)規(guī)則，并提供了不同類型的標(biāo)識(shí)符的示例。

三、代碼規(guī)范

3.1每行聲明數(shù)

一行只建議作一個(gè)聲明，并按字母順序排列。如

         int level;   //推薦

          int size;    //推薦

          int x, y;    //不推薦

3.2 初始化

      建議在變量聲明時(shí)就對(duì)其做初始化。

3.3 類和接口的聲明

      1 在方法名與其后的左括號(hào)間沒(méi)有任何空格。

      2 左花括號(hào) “{” 出現(xiàn)在聲明的下行并與之對(duì)齊，單獨(dú)成行。

      3 方法間用一個(gè)空行隔開(kāi)。

3.4 字段的聲明

不要使用是 public 或 protected 的實(shí)例字段。如果避免將字段直接公開(kāi)給開(kāi)發(fā)人員，可以更輕松地對(duì)類進(jìn)行版本控制，原因是在維護(hù)二進(jìn)制兼容性時(shí)字段不能被更改為屬性。考慮為字段提供 get 和set 屬性訪問(wèn)器，而不是使它們成為公共的。 get 和 set 屬性訪問(wèn)器中可執(zhí)行代碼的存在使得可以進(jìn)行后續(xù)改進(jìn)，如在使用屬性或者得到屬性更改通知時(shí)根據(jù)需要?jiǎng)?chuàng)建對(duì)象。下面的代碼示例闡釋帶有g(shù)et 和 set 屬性訪問(wèn)器的私有實(shí)例字段的正確使用。 示例：

           public class Control: Component

            {

               private int handle;

               public  int Handle

               {

                  get

                  {

                     return handle;

                  }

               }

}

四、            控件命名規(guī)則

4.1 命名方法

控件名簡(jiǎn)寫(xiě)+下劃線＋英文描述，英文描述首字母大寫(xiě)

4.2   主要控件名簡(jiǎn)寫(xiě)對(duì)照表

控件名                          簡(jiǎn)寫(xiě)            控件名                        簡(jiǎn)寫(xiě)

Label                              lbl             TextBox                               txt

Button                            btn            LinkButton                     lnkbtn

ImageButton                imgbtn         DropDownList                ddl

ListBox                           lst             DataGrid                     dg

DataList                       dl              CheckBox                          chk

CheckBoxList                   chkls         RadioButton                       rdo

RadioButtonList                 rdolt          Image                                  img

Panel                             pnl            Calender                              cld

AdRotator                         ar             Table                                  tbl

RequiredFieldValidator         rfv             CompareValidator                 cv

RangeValidator                  rv               RegularExpressionValidator    rev

ValidatorSummary             vs             CrystalReportViewer             rptvew