編碼規範

1、註釋規範

一、源文件頭部的註釋規範 

// =======================================================
// Copyright (C) 2012-2013 XXX研發中心
// 文件名：FileName.cs
// 做  者：張三
// 日  期：2013/01/01
// 描  述：介紹本文件所要完成的功能及背景信息等等
// 版  本：1.00
// 修改歷史記錄
// 版本   修改時間       修改人      修改內容
// 1.01   2012/01/02     李四        修改的具體內容1
// 1.02   2012/02/01     王五        修改的具體內容2

//======================================================= 

二、模塊（類）註釋規範 

///<summary>

///類的功能描述

///</summary> 

三、方法註釋規範

///<summary>

///說明

///</summary>

///<param name="<參數名稱>">參數說明</param>

///<returns>

///對方法返回值的說明，該說明必須明確說明返回值表明的含義

///</returns> 

四、代碼註釋規範 

//單選註釋 

/*多行註釋1

多行註釋2*/ 

五、版本封存後的修改必定要保存原有的代碼，不能直接刪除或修改，而且要在文件頭及修改地點記錄修改過程。 

（1）增長一段代碼： 

int  n=MyFunc();
......
// added by 李四 2012/03/07 begin
// 版本號：1.01
// 增長緣由
string  str= " 1111 " ;
str=str+ " 2222 " ;
......
// added by 李四 2012/03/07 end

（2）修改一段代碼： 

int  a,b,c;
......
// modified by 李四 2012/03/08 begin
// 版本號：1.01
// 修改緣由
// int sum=a+b+c; // 這是原來的代碼
int  sum=a+b*c; // 這是修改後的代碼
// modified by 李四 2012/03/08 end 
（3）刪除一段代碼：

//deleted by 王五 2013/08/08 begin

//版本號：1.02

//刪除緣由

//int sum=a+b+c;

//deleted by 王五 2013/08/08 end 

2、命名

Pascal命名：將標識符的首字母和後面鏈接的每一個單詞的首字母都大寫。例如：BackColor。

Camel命名：標識符的首字母小寫，每一個後面鏈接的單詞的首字母都大寫。例如：backColor。 

3、匈牙利命名法 

命名的基本原則是：變量名=屬性+類型+對象描述 

（1）屬性部分： 

      全局變量：g_ 

      常量：c_ 

      類成員變量：m_ 

      靜態變量：s_ 

（2）類型部分： 

      指針：p 

      函數：fn 

      無效：v

      句柄：h 

      長整型：l 

      布爾型：b 

      浮點型（有時也指文件）：f

      雙字：dw 

      字符串：s

      短整型：n 

      雙精度浮點：d 

      計數：一般用cnt

      字符：ch

      整型：i

      字節：by 

      字：w 

      實型：r 

      無符號：u 

（3）描述部分： 

      初始化：Init

      臨時變量：Tmp 

      目的對象：Dst 

      源對象：Src 

      窗口：Wnd 

4、一些好的編碼規範 

一、爲了層次清晰，在閉合的右括號後註釋該閉合所對應的起點。 

namespace.Langchao.Procument.Web 

{  

} //namespace.Langchao.Procument.Web 

二、在類屬性的名稱中包含類名是多餘的，如：Book.BookTitle應該使用Book.Title。

三、只要合適，在變量名的末尾或開關加計算限定符（Avg、Sum、Min、Max、Index）。 

四、在變量名中使用互補對，如：min/max、begin/end、open/close。 

五、布爾變量名應該包含Is，意味着Yes/No、True/False值。

六、即便對於可能僅出如今幾個代碼行中的生存期很短的變量，仍然使用有意義的名稱。僅對於短循環索引使用單字母變量名，如i或j。可能的狀況下，儘可能不要使用原義數字或原義字符串，如：For i=1 To 7，應該使用命名常數，如For i=1 To NUM_DAYS_IN_WEEK以便於維護和理解。