嗚嗚喔學習筆記: C# Coding Standards ( Coding 標準 )

搜尋此網誌

2016年8月28日 星期日

C# Coding Standards ( Coding 標準 )

參考 MSDN 的coding style 以下是整理最 基礎 , 常使用 的部分

基礎規則:
  • 使用大駱駝 Pascal( 如 : "VirtualDesign" )小駱駝Camel( 如 : "virtualDesign" )
    • 不要使用分隔符號( 例如底線 "_" 或連字號 "-" )來做命名 ( EX: (X) User_Name_Api_Path )
  • 可讀性優先於簡潔性( CanScrollHorizontally 優於 ScrollableX ),並參考常用的命名( HorizontalAlignment 優於 AlignmentHorizontal )。
  • 避免使用匈牙利命名法( 如 : "strName", )
    • 不要使用型態前致詞( ex: (x)strName ,)
    • Bool 例外 "Can" , Is 或 "Has"( EX: (O)bool isPlay )
    • 使用後致詞
      • System.EventArgs :  AppleEventArgs    
      • System.Exception :  WtfException
      • System.Attribute : LoginAttribute
      • Instance (Field): CubeInstance
  • 正確的使用縮寫 (沒事不要用縮寫)
    • 兩字皆為大寫( 如 : "IO" , "DB" , system.IO  )
    • 三個字以上 ( 如 : "Xml" )
物件命名規則:
  • Interface : 前面+I ( EX: Car : ICar )
  • Generic (泛型) : 前面+T , K ( EX:  class List <TKey , TValue > )
  • Field :
    • public : 大寫開頭 ( EX : public string UserName )大駱駝
    • private :  ( EX: private string _userName )_小駱駝
    • private Const -> WTFUSER ;
  • Local Variable : 小寫開頭 ( EX: string userName )小駱駝
  • Const (static readonly) Variable 全大寫_ (EX: WTF_PATH = “@C:\” )
  • Parameter : 小寫開頭 ( EX: userName )
  • var 不可以寫在成員 public private

沒有留言:

張貼留言