附錄一.Windows控制元件縮寫規範

附錄二.命名規範

一.類

1.1..使用Pascal規則命名類名,即首字母要大些.。

如：

Class person

ClassBmpFileStream

1.2.使用能夠反映類功能的名詞或名詞短語命名類。

   如：

public classFileStream

public class Button

public classstring

1.3.不要使用“_”,”C”,”I”等特定含義字首。

   如：

class –ManagerSystem

classCManagerSystem

classImanagerSystem

1.4.自定義異常類應以Exception結尾。

  如：

   Public class EmailException:Exception

   {

   //類體

}

1.5.檔名要能反映類的內容，最好是和類同名。

二、類欄位

 2.1.用camel規則來命名類成員變數名稱，即首單詞（或單詞縮寫）小寫。

    如：

class Student

{

string stuName;

string stuNo;

string password;

}

2.2.類欄位變數名前加”_”字首。

如：

Class student

{

String_stuName;

String _stuNo;

}

 2.3堅決在普通變數前加”m_”字首（這是VC老命名規則）。

如：

Class Student

{

    sting m_stuName;

   sting m_stuNo;

}

三. 方法

  3.1方法採用Pascal規則，第一個字元要大寫。

如：

  public void DoubleVaule(){…}

  public void Show(){…}

3.2方法名應使用動詞或動詞短語。

如：

  void RemoveAll(){…}

  void GetCharArray(){…}

  void Invoke()

3.3類中訪問修飾符或者功能相同的方法應該放在一起，且公共或實現介面的方法在前。

 如：

Class Test

{

    public void Invoke(){…}

    public void Insert(){…}

    private void RemoveAll(){…}

    private void GetCharArray(){…}

}   

四.屬性

 4.1使用名詞定義屬性，屬性使用Pascal規則，首字元大寫。

如: 

 public class Book

     {

        public Color BookName

         {

   //屬性程式碼

} 

}

4.2屬性和相應欄位名稱要關聯，可以使用”重構”選單來生成屬性.

   如:

      publicclass Book

{

private string bookName;

public Color BookName

{

                     Get{returnbookName;}

}

}

五.引數

5.1引數採用camel規則命名，首字元小寫。

     如：

       String Format(string format,object[] args){…}

5.2使用描述性引數名稱，引數名稱應當具有足夠的說明性。

5.3不要給引數加匈牙利型別表示法的字首。

    如下面是不合理的：

             voidInsert(string sName,string strAddress)

應該為：

            void Insert(stringname,string address)

5.4檢查方法所有輸入引數的有效性。

六.常量

6.1只讀常量使用Pascal命名規則，即首字母大寫。

如：

class Calendar

{

          public readonlyColor RedColor;

          public constTuesday;

}

6.2列舉命名使用Pascal規則命名，列舉成員本質屬於常量，命名規則同上。

 如：

     enum  CarColor { Red , Blue , Yellow }

6.3列舉值從小到大順序定義。

如：

 enumCarColor

{

          Red = 1;

          Blue= 2;

          Yellow = 3;

}

6.4靜態欄位或屬性採用Pascal規則，首字元大寫。

       public class Component:IComponent

       {

        static string typeName;

        public static string TypeName{get;set}

}

七.介面

7.1介面定義使用Pascal規則，且必須以大寫”I”開頭。

     public interfaceIDatePort

     public interfaceIFormatable

7.2介面名稱要有意義，中間不要有下劃線”_”等字串。

    如：  

     interface I_Date_Port 是不合適的。

7.3如果類實現了介面，名稱儘量和介面相同，只是省掉”I”字元。

 public interface IComponent

{

  //介面定義

}

public classComponent: IComponent

{

      //類實現

}

八.事件

8.1委託名稱採用Pascal規則，第一個字元大寫。

    如：

      public delegate voidCountHandler(int x,int y);

8.2定義事件的委託要使用EventHandler字尾，且包括sender和e兩個引數。

如：

Delegate voidMouseEventHandler(object sender,MouseEventArgs e) ;

8.3事件用到的引數類，名稱要帶EventArgs字尾。

如：

public classMouseEventArgs:EventArgs

{

             //引數類內容

}

九.名稱空間

9.1名稱空間名稱採用Pascal規則，首字元大寫。

如：

NamespaceHairCompany

{

  //名稱空間內容

}

9.3名稱空間名稱儘量反映其內容所提供的整體功能。

如：

Microsoft.Media

Microsoft.Media.Design

附錄三.註釋規範

一.檔案頭部註釋

1.1 檔案都包含檔案頭，要說明檔名、作者、建立時間、變更記錄等。

 如：

/***********************

*檔名：CarPrint.cs

*作者：趙建磊

*建立日期：2010-05-23

*描述：完成列印功能

*修改日期：2009-11-23

*Email:[email protected]

***********************/

1.2推薦採用.NET形式書寫頭部註釋。

如：

///<summary>

///檔名：CarPrint.cs

///作者：趙建磊

///建立日期：2010-05-23

///描述：完成列印功能

///修改日期：2009-4-23

///Email:[email protected]

///</summary>

二.類及其成員註釋

2.1對方法和類使用”///”三斜線註釋。

如：

///<summary>

///功能：對此類功能的描述

///作者：作者中文名

///日期：編寫日期等

///描述：完成列印功能

///修改日期：2009-11-23

///</summary>

ClassBookSystem

{

    ///<summary>

///圖書詳細資訊查詢

///</summary>

Public DataSetSelectBooks(int id)

{

}

}

2.2.程式碼行文註釋採用”//”和”/**/”進行，應量說明問題。

 PublicDataSet SelectBooks(int id /*書籍ID*/)

{

  DataSet dsBook;//註釋資料集

}

2.3新增的註釋必須能夠說明此語句塊的作用和實現手段。

2.4所有的註釋都應該用英文或者中文，同一段註釋不要混用兩種語言。

2.5程式碼變更需要將舊程式碼註釋，並且說說明變更原因、變更作者和變更時間。

附錄四.行文規範

                             不可按外貌斷定是非，要按公平斷定是非。

                                                    -----《新約》（john）

版面

儘管在定義程式碼樣式的格式時,你可以做出很多個性化的選擇，但所有這些都是關於審美的。從定義上看，樣式沒有任何句法或語義上的意義；編譯器會忽略樣式。然而原始碼的真正讀者是其他程式設計師。編寫程式碼時要為他們的利益著想。

u   K&R括號風格

K&R風格是最早為人們所喜愛的風格，它是由C語言之父Kernighan和Ritchie在他們的《C程式設計語言》一書中確立的。由於這個原因，這種風格常被認為是最初和最好的風格。它的誕生來源於在一個小螢幕中顯示儘可能多的資訊的需求。

int k_and_r( ) {

  int a = 0, b = 0;

  while (a != 10) {

              b++;

              a++;

}

return b;

}

優點

l       佔用空間較小，所以在一屏上一次可以顯示更多的程式碼

l       後括號與相對應的語句縮排相同，所以可以很容易地找到括號所終止的構造

缺點

l       前括號和後括號上下不對齊，所以視覺上不易匹配

l       如果頁面右側的前括號丟失，將很難發現

l       程式碼語句看上去擠作一團

u   Allman括號風格

Allman括號風格是一種空間上更開闊的方法。這也是C#語言在國內最流行的風格。

Int exdented( )

{

      Int a = 0,b = 0;

      While (a != 10)

{

             b++;

             a++;

}

Return b;

}

優點

l       格式清晰整潔

l       每個程式碼塊都更易於區分

缺點

l       佔用的豎向空間更多

l       如果你有很多隻包含一條語句的程式碼塊，那麼會顯得很浪費空間

l       對某些黑客而言這太像Pascal語句了

縮寫規範

l       識別符號應當直觀可望文知意，不提倡使用任何縮寫。

l       字串變數推薦以“str”或“s”開頭，採用string.Empty來初始化。

    如：

    String strName = string.Empty;

l       普通物件可以以“obj”開頭。

    如：

    Book objBook=new Book( );

l       縮寫可自行定義，一般取單詞的前/後字元組成，以含義直觀為準則。

合理名稱如：

Label lblName;

Lable lbName;

Color bkColor;

ColorbackgroudColor;

Color bgColor;

l       一般情況下不要讓縮寫破壞識別符號的含義。

如：

Public StudentGetStudent( )

排版

l       每行語句至少佔一行，如果語句過（超過一屏），則語句斷為兩行顯示。

如：

Public void Insert(string bookName,

String bokID,

String bookDetail,

Int bookNumber

);

下列定義不合理：

frmMain.Width = 0;frmMain.Height=0;

應為：

frmMain.Width = 0;

frmMain.Height=0;

l       把相似的內容放在一起，比如欄位、屬性、方法、事件等，使用“#region”命令分組。

如：

Class Book

{

       #region構造方法

              PublicBook(string name) {…}

       #endregion

       #region公共方法

              PublicBook GetBookByName(string name) {…}

       #endregion

       #region屬性

              Publicstring Name{…}

       #endregion

       #region私有欄位

              Privatestring name;

#endregion

}

l       多個程式元素進行對等操作時,操作符之前、之後或者前後要加空格。

如：

If (!ValidNi(ni))

{

       //程式程式碼

}

nRepssnInd = SsnData[index].nRepssnIndex;

nRepssnNi = SsnData[index].ni;

l       每個方法的源程式行數原則上應該少於200行。

l       語句巢狀層次不得超過3層。

l       避免相同的程式碼段在多個地方出現。

語句結構

l       如果使用了異常結構,一定要處理異常,一般是要寫日誌檔案。

如：

try

{

      //異常監控程式碼

}

Catch（Exception e）

{

      Log.WriteLine(e.Messge);

}

l       分支語句不應該使用複雜長條件。

如：

If(txtName ==null || txtName == string.Empty)

{

      //處理程式碼

}

應該將長條件封裝成方法：

if(txtNameEnable( )) {…}

switch語句，case後面必須接break（這一點C#已經強行限制）。

l       禁止使用goto語句進行跳轉。

l       行文中嚴禁出現“魔數”，特定含義的常數必須定義成列舉或常量。

如：

if( objCar.Type==1) objCar.Run( );

應為：

if（objCar.Type==Cars.BMP）objCar.Run( );

l       不同型別的操作符混合使用時，使用括號給出優先順序。

如：

if( year % 4 == 0|| year % 100 != 0 && year % 400 == 0)

應為：

If（（year % 4） == 0 ||((year % 100) != 0 && (year % 400) == 0 )）

l       不允許使用複雜的操作符組合。

如：

maxVal = ((a>b ? a:b) > ? (a>b ? a : b) : c);

應該為：

temp = (a>b ? a : b);

maxVal = ( iTemp > b ? iTemp : b);

l       迴圈、判斷語句的程式塊部分用花括號括起來，即使只有一條語句。

如：

if（condition）

     flag = true;

推薦改為：

if（condition ）

{

     flag = true;

}

l       在switch語句中總是要有default子句，建議使用斷言。

CarType type = GetType( );

Switch (type)

{

     case CarType.GMC:

            return new GMCCar();

            break;

     case CarType.BMW:

            return new BMWCar();

            break;

     default:

            Debug.Assert(false);

            break:

}

l       每個類和方法完成單一的功能，不設計多用途面面俱到的類和方法。

l       嚴禁使用未經初始化的變數，變數通常使用構造方法來初始化。

大小寫

l       不要建立名稱相同，但大小寫區別的任何元素。

如：

Void MyFunction(string a, string A)

int Color {get, set}

int CoLor{get,set}

l       應當大寫僅有兩個字元的縮寫。

如：

string stuID;

l       不要把易混淆的數字和字母放在一起。

如：

string r = (lo == 10) ? (I1 == 11) : (lol != 101);

l       使用英文命名識別符號。

l       不允許變數名、類名、屬性名、方法名等與系統識別符號重名。

SQL編碼規範

l       SQL語句全部大寫。

如:

SELECT psnNameFROM person

CREATE PROC p_Selectproc

l        對較複雜的SQL語句加上註釋，說明其功能。

l        連線符OR、IN、AND、以及=、<=、>=等前後加上一個空格。

l        使用明確的列代替SELECT*。

如：

SELECT  A.ID, A.NAME, B.ID, B.NAME

FROM  CLASS A, PERSON B

WHERE  A.ID = B.ID

AND　A.GRADE = ‘5’

軟體架構

l        資料庫中每一張表對應一個實體類／所據傳輸物件（ＤＴＯ）。

l        實體類名稱使用表名，也可帶有Ｄｔｏ字尾。

如：

classpersonDto

{

    Public String Nme

    {

    get{return name;}

    get{this.name = value;}

}

}

l        三層架構應當合理使用，不應生搬硬套。

三層架構元素推薦字尾：

資料傳輸物件 XxxxDto

DAO工廠    XxxDAOFactory

DAO介面    IXxxxDAO

服務介面     IXxxxService

DAO的資料庫實現  XxxxDAOOracle/XxxxDAOInfomix

業務邏輯     XxxxManger

系統

l        在國內不要隨便使用設計模式等程式碼模式，因為並不流行。

l        系統輸入、資源操作、（如記憶體分配、檔案及目錄操作）、網路操作（如通訊、呼叫等）、任務之間的操作（如通訊、呼叫等）時必須進行錯誤、超時或異常處理。

l      模組編寫應該有完善的測試方面的考慮。