VS.NET 2003命名規範

遵從以下良好的習慣以寫出好程序
 避免使用大文件。如果一個文件裏的代碼超過300~400行,必須考慮將代碼分開到不同類中。
 避免寫太長的方法。一個典型的方法代碼在1~25行之間。如果一個方法發代碼超過25行,應該考慮將其分解爲不同的方法。
 方法名需能看出它作什麼。別使用會引起誤解的名字。如果名字一目瞭然,就無需用文檔來解釋方法的功能了。
    註記 : 
    Pascal: 大小寫形式-所有單詞第一個字母大寫,其他字母小寫。(MyTable
   Camel : 大小寫形式-除了第一個單詞,所有單詞第一個字母大寫,其他字母小寫。(myTable)
1.類名使用Pascal 大小寫形式 
        public class HelloWorld{ ...}
    以Class聲明的類,都必須以名詞或名詞短語命名,體現類的作用。如:
        Class Indicator
    當類是一個特性(Attribute)時,以Attribute結尾,當類是一個異常(Exception)時,以Exception結尾:
        Class ColorSetException
        Class CauseExceptionAttribute

2.方法使用Pascal 大小寫形式 
    無論是函數還是子程序,方法都必須以動詞或動詞短語命名。無需區分函數和子程序,也無需指明返回類型。
        public class HelloWorld{ void SayHello(string name) {  ... }}
3.變量和方法參數使用Camel 大小寫形式
       Int age,string name,string myName
4.不要使用匈牙利方法來命名變量
        String m_sName
    這種方式在.NET編碼規範中是不推薦的。所有變量都用Camel 大小寫形式,而不是用數據類型和m_ 來作前綴。
5. 屬性使用Pascal大小寫形式
    在面向對象的語言中,在類屬性的名稱中包含類名是多餘的,如 Book.BookTitle。而是應該使用                    
        Book.Title,KingDown
6.枚舉和結構
    同樣必須以名詞或名詞短語命名。最好體現枚舉或結構的特點,如:
        Enum ColorButtons '以複數結尾,表明這是一個枚舉
        Structure CustomerInfoRecord '以Record結尾,表明這是一個結構體
7.接口
    與其他類型不同,接口必須要由I作爲前綴,並用形容詞命名,突出表現實現接口的類將具有什麼能力:
        Interface ISortable
8.代碼書寫規範
    格式化使代碼的邏輯結構很明顯。確保源代碼以一致的邏輯方式進行格式化,這對於開發小組,以及以後維護源代碼的其他開發人員都有很大的幫助。
    縮進大小(四個空格/Tab鍵)
     for (i = 0; i < 100; i++) //示列1
     {
            //此處填寫代碼塊;
       }
     if(expression )  // 示列2
     {
             if(expression )
               {
                  //此處填寫代碼塊;
               }
              else
               {
                  //此處填寫你的代碼塊;
               }
     }

    SQL語句 將每個主要的 SQL 子句放在不同的行上,這樣更容易閱讀和編輯語句
        SELECT FirstName, LastName
        FROM Customers
        WHERE State = 'WA'

9.註釋
    •  別每行代碼,每個聲明的變量都做註釋。 
    •  在需要的地方註釋。可讀性強的代碼需要很少的註釋。如果所有的變量和方法的命名都很有意義,會使代碼可讀性很強並無需太多註釋。 
    •  行數不多的註釋會使代碼看起來優雅。但如果代碼不清晰,可讀性差,那就糟糕。 
    •  如果應爲某種原因使用了複雜艱澀的原理,爲程序配備良好的文檔和重分的註釋。 
    •  對一個數值變量採用不是0,-1等的數值初始化,給出選擇該值的理由。 
    •  簡言之,要寫清晰,可讀的代碼以致無須什麼註釋就能理解。 
    •  對註釋做拼寫檢查,保證語法和標點符號的正確使用。

發佈了36 篇原創文章 · 獲贊 0 · 訪問量 3萬+
發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章