在 .NET 平臺和 C# 開發中，遵循一致的命名規則是確保代碼可讀性、可維護性和團隊協作效率的關鍵。
1. 類和接口的命名
- ? 類名：使用帕斯卡命名法（PascalCase），即每個單詞的首字母大寫，不包含下劃線。類名應為名詞或名詞短語，避免使用縮寫（除非是廣泛認可的縮寫）。例如：
public class BankAccount { }
- ? 接口名：接口名稱以大寫字母
I 開頭，后跟帕斯卡命名法。例如：public interface ISortAlgorithm { }
2. 方法和屬性的命名
- ? 方法名：使用帕斯卡命名法，通常為動詞或動詞短語，清晰表達方法的功能。例如：
public UserInfo GetUserInfo(int userId) { }
- ? 屬性名：使用帕斯卡命名法，通常為名詞或名詞短語。例如：
public string FirstName { get; set; }
- ? 布爾屬性：布爾屬性通常以
Is、Can 或 Has 開頭，例如 IsEnabled、CanExecute。
3. 變量和字段的命名
- ? 局部變量和參數：使用駝峰命名法（camelCase），即第一個單詞小寫，后續單詞首字母大寫。例如：
public void CalculateTotal(decimal totalPrice) { }
- ? 私有字段：私有字段以
_ 開頭，后跟駝峰命名法。例如：private string _userName;
- ? 靜態字段：靜態字段以
s_ 開頭，后跟駝峰命名法。例如：private static int s_totalCount;
4. 常量的命名
- ? 常量名：使用全大寫字母，單詞間用下劃線分隔。例如：
public const int MAX_USERS = 1000;
5. 枚舉的命名
- ? 枚舉類型：使用帕斯卡命名法，非標記枚舉使用單數名詞，標記枚舉使用復數名詞。例如：
public enum UserState { Success, Fail }
6. 命名空間的命名
- ? 命名空間：使用帕斯卡命名法，并遵循反向域名表示法。例如：
namespace MyCompany.MyProduct { }
7. 其他注意事項
- ? 避免縮寫：除非是廣泛認可的縮寫，否則盡量避免使用縮寫。
- ? 避免僅靠大小寫區分標識符：例如，不要同時使用
int x 和 int X。 - ? 避免在不同作用域中重名：例如，不要在局部變量和全局變量中使用相同的名稱。
- ? 復數類型命名：集合或數組優先使用復數形式，例如
userNames 或 userNameList。
8. 常見命名規則
8.1 駝峰命名法（CamelCase）
規則：
- ? 第一個單詞的首字母小寫，后續單詞的首字母大寫。
示例：
firstName // 變量名
lastName // 變量名
calculateTotalPrice // 函數名
8.2 蛇形命名法（Snake_Case）
規則：
示例：
first_name // 變量名
last_name // 變量名
calculate_total_price // 函數名
8.3 帕斯卡命名法（PascalCase）
規則：
示例：
FirstName // 變量名
LastName // 變量名
CalculateTotalPrice // 函數名
8.4 大寫常量命名法（SCREAMING_SNAKE_CASE）
規則：
示例：
MAX_SIZE // 常量名
PI // 常量名
8.5 匈牙利命名法（Hungarian Notation）
規則：
- ? 在變量名前添加前綴，表示變量的類型或用途。例如：
8.6 其他命名規則
- ? 單詞之間用短橫線
- 分隔，常用于 HTML 類名、CSS 屬性等。例如：first-name、calculate-total-price。
- ? Upper CamelCase（大駝峰命名法）：
- ? 與帕斯卡命名法類似，但通常用于特定場景，如某些語言的模塊名或包名。
https://learn.microsoft.com/zh-cn/dotnet/fundamentals/code-analysis/style-rules/naming-rules
該文章在 2025/3/24 17:10:21 編輯過
400 186 1886
