C#項目代碼規範

来源:http://www.cnblogs.com/hugz/archive/2016/07/09/5655786.html
-Advertisement-
Play Games

C#項目代碼規範 前言 小菜就是小菜,幾個人搞出來的項目,讓公司大牛稍微看了下,最後送出了慘不忍睹四個字。命名各種各樣,五花八門,大寫英文、小寫英文、大寫拼音、小寫拼音、英文和拼音組合、字母和特殊字元(下劃線等)組合。這樣的項目代碼要是讓人來維護或者添加功能、查找bug會頭痛欲裂。也沒辦法誰叫咱們是 ...


C#項目代碼規範

 

前言

   小菜就是小菜,幾個人搞出來的項目,讓公司大牛稍微看了下,最後送出了慘不忍睹四個字。命名各種各樣,五花八門,大寫英文、小寫英文、大寫拼音、小寫拼音、英文和拼音組合、字母和特殊字元(下劃線等)組合。這樣的項目代碼要是讓人來維護或者添加功能、查找bug會頭痛欲裂。也沒辦法誰叫咱們是小菜呢?而且程式員最頭疼的事:http://kb.cnblogs.com/page/192017/這篇知識博文里,最終的結果居然是命名。所以……

  於是結合現有項目,通過博客園查看各種博客文章,進行了一下總結。當然這樣做肯定是有不少好處的。

  1.方便代碼的交流和維護。

  2.不影響編碼的效率,不與大眾習慣衝突。

  3.使代碼更美觀、閱讀更方便。

  4.使代碼的邏輯更清晰、更易於理解。

在C#中通常使用的兩種編碼方式如下

  Camel(駝峰式): 大小寫形式-除了第一個單詞,所有單詞第一個字母大寫,其他字母小寫。
  Pascal(帕斯卡): 大小寫形式-所有單詞第一個字母大寫,其他字母小寫。

本文的C#代碼規範主要參考的是大神的規範:http://www.cnblogs.com/JimmyZhang/archive/2013/06/05/3118936.html,當然還有其他的,在此就不一一進行列舉了。

C#代碼規範

1、 類型(類、結構、委托、介面)、欄位、屬性、方法、事件的命名

  優先考慮使用英文(儘量使用英文),如果實在沒有合適的英文進行描述,可以使用拼音,使用中文是不符合要求的。

 

2、不使用縮寫

  所有類型、欄位、屬性、方法、事件儘量不使用縮寫,包括大家熟知的縮寫,例如msg。

 

3、不使用單個字母的變數

  不使用單個字母的變數, 像 i、m、n,使用index等來替換,用於迴圈迭代的變數除外。

 

 

4、用Tab作為縮進,並設置縮進大小為4

 

5、 註釋

類型、屬性、事件、方法、方法參數,根據需要添加註釋。

如果類型、屬性、事件、方法、方法參數的名稱已經是自解釋了,不需要加註釋;

否則需要添加註釋。

 

6、類型名稱和源文件名稱一致

當類型命名為Product時,其源文件命名只能是Product.cs。

 

7、所有命名空間、類型名稱使用Pascal風格

 

8、本地變數、方法參數名使用Camel風格(不使用下劃線)

紅色標記的為使用Camel風格的變數或者方法參數

 

9、在一個類中,各個方法需用一空行(最好是一個空行)

 

10、避免使用大文件。如果一個文件里的代碼超過300-400行,必須考慮將代碼分開到不同的類中。同時避免寫太長的方法,如果一個方法代碼過長(暫時沒有明確指出方法的行數),應該考慮將其分解為不同的方法

 

11、一個方法只完成一個任務。不要把多個任務組合到一個方法中,即使那些任務非常小

 

12、調用類型成員內部其他成員,需加this,調用父類成員需加base

 

13、不在代碼中使用具體的路徑和驅動器名。 使用相對路徑,並使路徑可復用

 

14、不要“捕捉了異常卻什麼也不做“。如果隱藏了一個異常,你將永遠不知道異常到底發生了沒有

 

15、如果if語句塊的內容只有一行,可以不加花括弧,並且最好和if語句位於同一行

 

16、類型內部的私有欄位和受保護欄位,使用Camel風格命名,但加“_”首碼

 

 

17、類型成員的排列順序

類型成員的排列順序自上而下依次為:

欄位:私有欄位、受保護欄位

屬性:私有屬性、受保護屬性、公有屬性

事件:私有事件、受保護事件、公有事件

構造函數:參數數量最多的構造函數,參數數量中等的構造函數,參數數量最少的構造函數

方法:重載方法的排列順序與構造函數相同,從參數數量最多往下至參數最少

 

18、委托和事件的命名

委托以EventHandler作為尾碼命名,例如 SalesOutEventHandler。

事件以其對應的委托類型,去掉EventHandler尾碼,並加上On首碼構成。

示例代碼如下:

 

19、返回bool類型的方法、屬性的命名

如果方法返回的類型是bool類型,則其首碼為Is,例如:IsHidden。

如果某個屬性的類型為bool類型,則其首碼為Can,例如:CanHidden。

 

20、常見集合尾碼類型命名

凡符合下表所列的集合類型,應添加相應的尾碼。

 

21、常見欄位、屬性命名

欄位、屬性種類比較繁雜,因此僅列出最常用的幾項

 

總結

本文的規範,將會在接下來的新項目中進行參考使用,使用過程中遇到的問題或者意見,將會反饋到本文,也恭請各位客官前來參閱,共同優化。


您的分享是我們最大的動力!

-Advertisement-
Play Games
更多相關文章
  • 3. 記憶體數據 前面我們知道了,記憶體是按位元組編址,每個地址的存儲單元可以存放8bit的數據。我們也知道CPU通過記憶體地址獲取一條指令和數據,而他們存在存儲單元中。現在就有一個問題。我們的數據和指令不可能剛好是8bit,如果小於8位,沒什麼問題,頂多是浪費幾位(或許按位元組編址是為了節省記憶體空間考慮)。 ...
  • 隨著Linux程式的增多,軟體的安裝過程中經常出現許多令人頭疼的問題,比如,重覆機械的勞動,今天來分享一些解決方法.. ...
  • 我會用幾篇博客總結一下在Linux中進程之間通信的幾種方法,我會把這個開頭的摘要部分在這個系列的每篇博客中都打出來 進程之間通信的方式 管道 消息隊列 信號 信號量 共用存儲區 套接字(socket) 進程間通信(一)—管道傳送門:http://www.cnblogs.com/lenomirei/p ...
  • 題目描述 若某個家族人員過於龐大,要判斷兩個是否是親戚,確實還很不容易,現在給出某個親戚關係圖,求任意給出的兩個人是否具有親戚關係。 規定:x和y是親戚,y和z是親戚,那麼x和z也是親戚。如果x,y是親戚,那麼x的親戚都是y的親戚,y的親戚也都是x的親戚。 輸入輸出格式 輸入描述: 第一行:三個整數 ...
  • 0. 目錄 C#6 新增特性目錄 1. 老版本的代碼 早C#3中引入的集合初始化器,可是讓我們用上面的語法來在聲明一個字典或者集合的時候立即初始化一些項進去,其實在C#3中這是個語法糖,實質編譯後的結果是調用字典或者集合的Add方法逐一添加這些項。但是有一點小小的不直觀。先看看這個版的IL吧: 本質 ...
  • 這兩個月要做一個項目,正逢ASP.Net Core 1.0版本的正式發佈。由於現代互聯網的安全要求,HTTPS加密通訊已成主流,所以就有了這個方案。 本方案啟發於一個舊版的解決方案: ASP.NET Core 1.0 部署 HTTPS (.NET Framework 4.5.1) http://ww ...
  • 一、工具: vs2013[因為我現在用的也是2013,版本隨便你自己開心] sql2008[準備過久升級] 二、用到的語言: HTML+CSS+Jquery+Ajax+sqlserver HTML[相當於一個人] css[要穿衣服] Jquery[人要做一些動作,Jquery是對js一些常用方法的封 ...
  • 上一篇文章中寫到在.net中實體類跟json格式的相互轉換,今天在做具體轉換時候,發現之前版本的jsonhelp對於日期類型的轉換不全面。之前版本的jsonhelp中從實體類轉換成json格式時候,將日期格式轉成了時間戳的形式。在這裡對這個jsonhelp做出了更新。以解決轉換日期類型欄位的問題。代 ...
一周排行
    -Advertisement-
    Play Games
  • 移動開發(一):使用.NET MAUI開發第一個安卓APP 對於工作多年的C#程式員來說,近來想嘗試開發一款安卓APP,考慮了很久最終選擇使用.NET MAUI這個微軟官方的框架來嘗試體驗開發安卓APP,畢竟是使用Visual Studio開發工具,使用起來也比較的順手,結合微軟官方的教程進行了安卓 ...
  • 前言 QuestPDF 是一個開源 .NET 庫,用於生成 PDF 文檔。使用了C# Fluent API方式可簡化開發、減少錯誤並提高工作效率。利用它可以輕鬆生成 PDF 報告、發票、導出文件等。 項目介紹 QuestPDF 是一個革命性的開源 .NET 庫,它徹底改變了我們生成 PDF 文檔的方 ...
  • 項目地址 項目後端地址: https://github.com/ZyPLJ/ZYTteeHole 項目前端頁面地址: ZyPLJ/TreeHoleVue (github.com) https://github.com/ZyPLJ/TreeHoleVue 目前項目測試訪問地址: http://tree ...
  • 話不多說,直接開乾 一.下載 1.官方鏈接下載: https://www.microsoft.com/zh-cn/sql-server/sql-server-downloads 2.在下載目錄中找到下麵這個小的安裝包 SQL2022-SSEI-Dev.exe,運行開始下載SQL server; 二. ...
  • 前言 隨著物聯網(IoT)技術的迅猛發展,MQTT(消息隊列遙測傳輸)協議憑藉其輕量級和高效性,已成為眾多物聯網應用的首選通信標準。 MQTTnet 作為一個高性能的 .NET 開源庫,為 .NET 平臺上的 MQTT 客戶端與伺服器開發提供了強大的支持。 本文將全面介紹 MQTTnet 的核心功能 ...
  • Serilog支持多種接收器用於日誌存儲,增強器用於添加屬性,LogContext管理動態屬性,支持多種輸出格式包括純文本、JSON及ExpressionTemplate。還提供了自定義格式化選項,適用於不同需求。 ...
  • 目錄簡介獲取 HTML 文檔解析 HTML 文檔測試參考文章 簡介 動態內容網站使用 JavaScript 腳本動態檢索和渲染數據,爬取信息時需要模擬瀏覽器行為,否則獲取到的源碼基本是空的。 本文使用的爬取步驟如下: 使用 Selenium 獲取渲染後的 HTML 文檔 使用 HtmlAgility ...
  • 1.前言 什麼是熱更新 游戲或者軟體更新時,無需重新下載客戶端進行安裝,而是在應用程式啟動的情況下,在內部進行資源或者代碼更新 Unity目前常用熱更新解決方案 HybridCLR,Xlua,ILRuntime等 Unity目前常用資源管理解決方案 AssetBundles,Addressable, ...
  • 本文章主要是在C# ASP.NET Core Web API框架實現向手機發送驗證碼簡訊功能。這裡我選擇是一個互億無線簡訊驗證碼平臺,其實像阿裡雲,騰訊雲上面也可以。 首先我們先去 互億無線 https://www.ihuyi.com/api/sms.html 去註冊一個賬號 註冊完成賬號後,它會送 ...
  • 通過以下方式可以高效,並保證數據同步的可靠性 1.API設計 使用RESTful設計,確保API端點明確,並使用適當的HTTP方法(如POST用於創建,PUT用於更新)。 設計清晰的請求和響應模型,以確保客戶端能夠理解預期格式。 2.數據驗證 在伺服器端進行嚴格的數據驗證,確保接收到的數據符合預期格 ...