基本注釋規范

1     規范目的

1. 一個軟件的生命周期中，80%的花費在於維護；
2. 幾乎沒有任何一個軟件，在其整個生命周期中，均由最初的開發人員來維護；
3. 編碼規范可以改善軟件的可讀性，可以讓程序員盡快而徹底地理解新的代碼。為了執行規范，每個軟件開發人員必須一致遵守編碼規范；
4. 使用統一編碼規范的主要原因，是使應用程序的結構和編碼風格標准化，以便於閱讀和理解這段代碼；
5. 好的編碼約定可使源代碼嚴謹、可讀性強且意義清楚，與其它語言約定相一致，並且盡可能的直觀。

2    例子

        

3    方法注釋規范

           ///<summary>

           ///說明：<對該方法的說明>

           ///</summary>

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

          ///<returns>

          ///<對方法返回值的說明，該說明必須明確說明返回的值代表什么含義>

          ///</returns>

 4     類注釋規范

          ///<summary>

         ///屬性說明

         ///</summary>

5    單行多行注釋

         1、單行注釋。格式：// 更改用戶姓名

         2、多行注釋。格式：/* 更改用戶姓名... */

6    命名規則

        1. 要采用大小寫混合，提高名字的可讀性。為區分一個標識符中的多個單詞，把標識符中的每個單詞的首字母大寫。不采用下划線作分隔字符的寫法。

　　　　有兩種適合的書寫方法，適應於不同類型的標識符：

　　　　　1、PasalCasing：標識符的第一個單詞的字母大寫；

　　　　　2、camelCasing：標識符的第一個單詞的字母小寫。

         2.  下表描述了不同類型標識符的大小寫規則：