程序師世界是廣大編程愛好者互助、分享、學習的平台,程序師世界有你更精彩!
首頁
編程語言
C語言|JAVA編程
Python編程
網頁編程
ASP編程|PHP編程
JSP編程
數據庫知識
MYSQL數據庫|SqlServer數據庫
Oracle數據庫|DB2數據庫
 程式師世界 >> 編程語言 >> .NET網頁編程 >> C# >> C#入門知識 >> 自己總結的C#編碼規范--6.格式篇

自己總結的C#編碼規范--6.格式篇

編輯:C#入門知識

自己總結的C#編碼規范--6.格式篇


格式 格式的統一使用可以使代碼清晰、美觀、方便閱讀。為了不影響編碼效率,在此只作如下規定:   長度 一個文件最好不要超過500行(除IDE自動生成的類)。 一個文件必須只有一個命名空間,嚴禁將多個命名空間放在一個文件裡。 一個文件最好只有一個類。 如果超過500行,考慮拆分類或者使用Partial 類將類按照功能拆分。 一個方法的代碼最好不要超過50行,如果超過考慮將裡面的邏輯封裝成函數。 空格、空行 空行的使用以使代碼清晰為為基本原則。空行影響程序的運行,但可以使代碼看起來清晰,增加可讀性,因此可以適當的使用。   方法與方法之間有兩個空行 函數內部變量聲明與函數內部邏輯之間有一個空行。 函數內部一個邏輯完成後要有一個空行,然後再寫下一個邏輯 換行 換行掌握的原則是不要使一行代碼特別長,以方便讀者快速閱讀。   請團隊所有成員開啟Visual Studio自動換行功能。 Tools->Options->Text Editor->C#->Check the Word wrap CheckBox       在不產生嚴重歧義或增加閱讀難度的情況下,盡量控制在80列以內,不能超過120列,以方便閱讀和代碼的打印。 另外換行的原則是,在逗號後,操作符前換行,換行與首行要保持一個單位的縮進。 "{"和"}"必須單獨在一行上,且上下對齊。 If,while,do,try-catch-finaly 等語句後必須有{},即使裡面只有一條語句或語句為空,且遵循"{"和"}"必須單獨在一行上上的規定。     Region的使用 Region的使用可以明確代碼塊的范圍並提供相應注釋,因此提倡大家盡量使用。   同時Region也可以用來組織代碼結構,我們使用以下Region約定來使組織類:   一個類應該用Region劃分出Fields、Properties、Constructor、Private Methods和 Protected & Public Methods 五個區域。並按照上述順序從上到下排列。 其中Fields、Properties、Constructor、Private Methods必須放在Region。而Protected & Public Methods 必須放在外面。Protected & Public Methods 是代碼閱讀者查找最頻繁的內容,這樣做可以方便代碼閱讀者使用Ctrl+M, O時能夠最快速度定位到自己想要查找的內容。 

  1. 上一頁:
  2. 下一頁:
Copyright © 程式師世界 All Rights Reserved