首頁
編程語言
C語言|JAVA編程
Python編程
網頁編程
ASP編程|PHP編程
JSP編程
數據庫
MYSQL數據庫|SqlServer數據庫
Oracle數據庫|DB2數據庫
您现在的位置: 程式碼之家 >> 編程語言 >  >> C語言 >> 關於C語言

C# 編碼標準:命名慣例與風格指南完整版

     編輯:關於C語言

命名慣例

目標慣例範例
類別、結構、介面、列舉、委派、方法、屬性、事件、常數、公開欄位PascalCaseCustomerOrder, CalculateTotal, MaxRetries
區域變數、方法參數、私有欄位camelCasecustomerList, orderId, _firstName
介面前綴 I + PascalCaseIRepository, IDisposable
私有/受保護實例欄位前綴 _ + camelCase (或 m_)_connectionString, m_userName
自訂屬性類別後綴 AttributeObsoleteAttribute, ValidateAttribute
自訂例外類別後綴 ExceptionInsufficientFundsException
泛型型別參數單一大寫字母 (T, K, V) 或 T + 描述T, TKey, TValue

方法命名

  • 動賓結構:ShowDialog(), SaveChanges(), GetUserById()
  • 布林回傳:IsValid(), HasPermission(), CanExecute()
  • 非同步方法:後綴 Async → GetDataAsync()
  • 事件處理器:OnEventName (受保護虛擬) / EventNameHandler (委派)

變數與型別

  • 使用 C# 關鍵字別名:int 不用 Int32, string 不用 String, object 不用 Object
  • 避免匈牙利命名法:strName → name, iCount → count
  • 布林變數加前綴:is, has, can, should

格式與排版

規則說明
縮排4 個空格 (Visual Studio 預設),不使用 Tab
大括號獨佔一行 (Allman 風格)
行寬建議 ≤ 120 字元
using 指示詞System 命名空間優先,第三方次之,專案內部最後,群組間空一行
檔案結構單一類別單一檔案,檔名 = 類別名 (+.cs)
部分類別多檔案時用 PartialClass.Part1.cs, PartialClass.Part2.cs

註解規範

  • 公開 API 必須有 XML 文件註解 (///)
  • 註解縮排與程式碼同層級
  • 避免解釋「做什麼」的明顯程式碼,專注「為什麼」與「非直觀邏輯」
  • 拼字檢查:中文註解需語句通順、術語一致

成員排序

  1. 常數
  2. 靜態欄位
  3. 實例欄位
  4. 建構子
  5. 屬性
  6. 方法
  7. 事件
  8. 巢狀類別

欄位與屬性/方法間空一行分隔。

現代工具整合

  • .editorconfig:跨編輯器統一風格
  • StyleCop.Analyzers / Roslyn Analyzers:建置時自動檢查
  • dotnet format:自動格式化
  1. 上一篇文章:
  2. 下一篇文章:
Copyright © 程式碼之家 All Rights Reserved