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

C# 命名規範實務指南:風格、原則、控制項前綴與命名空間組織

     編輯:關於C語言

前言

良好的命名能讓程式碼自文檔化,降低認知負荷。本文整理基於微軟官方規範與實務經驗的 C# 命名指南,涵蓋大小寫風格、識別符分類、核心原則、控制項前綴、命名空間組織。

大小寫風格

風格規則範例
PascalCase每個單字首字大寫BackColor, FileStream
camelCase首字小寫,後續單字首字大寫backColor, localVariable
全大寫所有字母大寫,縮寫/常數System.IO, MAX_VALUE

識別符分類與適用風格

識別符類型風格範例
參數、區域變數camelCasetypeName, typeId
private/protected 實例欄位camelCase_redValue, _isOk
介面控制項camelCase + 前綴txtUserName, btnSubmit
縮寫(≤2 字元)全大寫System.IO, UI
其他(類別、方法、屬性、公開欄位、常數)PascalCaseBackColor, CreateUser, PAGE_TITLE

核心原則

  1. 有意義、描述性:name, address, salary 而非 nam, addr, sal。
  2. 避免縮寫:除公認縮寫(Id, Xml, Html)。
  3. 避免單字母變數:迴圈索引除外(for (int i = 0; ...))。
  4. 類別用名詞/名詞片語:FileStream。
  5. 方法用動詞/動詞片語:CreateUser(), RemoveAt()。
  6. 介面以 I 開頭:IDisposable。
  7. 常數全大寫底線分隔:public const string PAGE_TITLE = "Welcome";。

控制項前綴表

前綴用於快速識別控制項型別,IntelliSense 輸入前綴即可過濾。

控制項前綴範例
LabellbllblName
TextBoxtxttxtEmail
ButtonbtnbtnSubmit
CheckBoxchkchkAgree
RadioButtonrdordoMale
CheckBoxListchklstchklstRoles
RadioButtonListrdolstrdolstGender
ListBoxlstlstItems
DropDownListddlddlCategory
DataGriddgdgOrders
DataListdldlProducts
ImageimgimgLogo
TabletbltblLayout
PanelpnlpnlContainer
LinkButtonlnkbtnlnkbtnDetail

命名空間組織


// 格式
CompanyName.ProjectName.TechnologyName[.Feature][.Design]

// 範例
Microsoft.Web.UI.Design
SiemensQuotation.BusinessRules.ProjectManagement
  • 巢狀命名空間應有依賴關係(內層依賴外層)。
  • 避免命名空間與類別同名(如 namespace Debug { class Debug {} } ❌)。
  • 公司/專案名過長可用公認縮寫全大寫。

結語

命名規範無絕對標準,但團隊內部必須統一。建議制定簡潔的《命名風格指南》(1-2 頁),新成員 10 分鐘內讀懂,Code Review 時以此為準。工具層面可引入 EditorConfig、StyleCop、Roslyn Analyzers 自動檢查。

  1. 上一篇文章:
  2. 下一篇文章:
Copyright © 程式碼之家 All Rights Reserved