編程--代碼規範

代碼規範
1.做用

1).提升可讀性
2).統領全局,促進團隊協助
3).有助於知識傳遞,加快工做交接
4).減小名字增生,下降維護成本
5).強調變量之間關係,下降缺陷引入的機會
6).提升程序員我的能力

2.規範

1).命名空間
2).代碼風格
    A).花括號不容許省略
    B).不容許省略訪問修飾符
    C).類型默認是密封的
    D).不容許公開字段
    E).使用括號強調運算優先級
3).命名規範(Pascal(大駝峯)、Camel(小駝峯))
    A).類、結構和接口命名
        a).使用名詞或名詞短語
        b).使用Pascal方式(增長識別和可讀性)
        c).在接口名稱前加上前綴I
        d).考慮在派生類末尾使用基類的名稱
        e).若是該類僅僅爲了實現某個接口,保持其與接口命名的統一
    B).成員命名
        a).方法(Pascal公開、Camel私有)    用動詞或動詞短語命名
        b).屬性(Pascal)                  用名詞、名詞短語或形容詞來命名(複數/布爾)
        c).事件(Pascal)                  用動詞或動詞短語來命名事件(如今時/過去時)
        d).字段(Camel私有)               用名詞、名詞短語或形容詞來命名
    C).參數命名
        a).Camel風格
        b).要使用left和right來命名重載的二元操做符的參數       若是參數沒有具體的含義
        c).要使用value來命名重載的一元操做符的參數             若是參數沒有具體的含義
        d).不要在參數中使用數字編號
        e).儘可能使用描述性的名字命名泛類型參數,並在前面使用T前綴
    D).常量、變量命名
        a).常量      全部單詞大寫用下劃線分隔
        b).局部變量   Camel風格
    E).枚舉命名
        a).Pascal風格
        b).使用名詞的複述形勢來命名標記枚舉
        c).不要添加ENUM或Flag後綴
        d).不要給枚舉類型值的名稱加前綴
    F).資源命名
        a).Pascal風格
        b).僅使用字母、數字和下劃線
        c).在命名異常信息的資源時，資源標識符應該是異常類型名加上簡短的異常標識符
        d).不要給枚舉類型值的名稱加前綴
    G).數據庫命名
        a).表          模塊名_表名
        b).字段        布爾類型用Is、Can、Has等表示；日期類型命名必須包含Date；時間類型必須包含Time
        c).存儲過程    使用proc_前綴        
        d).視圖        使用view_前綴
        e).觸發器      使用trig_前綴
    H).XML命名
        a).節點        Pascal風格
        b).屬性        Camel風格
4).註釋
    A).對接口和複雜代碼塊必須進行註釋
    B).修改代碼時保持註釋同步
    C).未完成的功能使用TODO標記
    D).修改他人代碼時要先註釋對方代碼，並寫明修改緣由，不容許隨便刪除他人代碼
    E).發佈前移除無用註釋
5).異常處理
    A).四種異常類型
        a).InvalidOperationException        無效操做
        b).ArgumentException                參數無效        
        c).ArgumentNullException            參數值不能爲NULL        
        d).ArgumentOutOfRangeException      參數越界
    B).在自定義異常時，必須使用VS提供的代碼模板來建立自定義異常