摘要:•类名:使用帕斯卡命名法(PascalCase),即每个单词的首字母大写,不包含下划线。类名应为名词或名词短语,避免使用缩写(除非是广泛认可的缩写)。例如:public classBankAccount{ }•接口名:接口名称以大写字母I开头,后跟帕斯卡命名法
在 .NET 平台和 C# 开发中,遵循一致的命名规则是确保代码可读性、可维护性和团队协作效率的关键。
• 类名:使用帕斯卡命名法(PascalCase),即每个单词的首字母大写,不包含下划线。类名应为名词或名词短语,避免使用缩写(除非是广泛认可的缩写)。例如:
public class BankAccount{ }• 接口名:接口名称以大写字母I开头,后跟帕斯卡命名法。例如:
public interface ISortAlgorithm{ }• 方法名:使用帕斯卡命名法,通常为动词或动词短语,清晰表达方法的功能。例如:
public UserInfo GetUserInfo(intuserId) { }• 属性名:使用帕斯卡命名法,通常为名词或名词短语。例如:
public stringFirstName { get; set; }• 布尔属性:布尔属性通常以Is、Can或Has开头,例如IsEnabled、CanExecute。
• 局部变量和参数:使用驼峰命名法(camelCase),即第一个单词小写,后续单词首字母大写。例如:
public void CalculateTotal(decimaltotalPrice) { }• 私有字段:私有字段以_开头,后跟驼峰命名法。例如:
private string_userName;• 静态字段:静态字段以s_开头,后跟驼峰命名法。例如:
private static ints_totalCount;• 线程静态字段:线程静态字段以t_开头。
• 枚举类型:使用帕斯卡命名法,非标记枚举使用单数名词,标记枚举使用复数名词。例如:
public enumUserState { Success, Fail }• 枚举成员:也使用帕斯卡命名法。
• 命名空间:使用帕斯卡命名法,并遵循反向域名表示法。例如:
namespace MyCompany.MyProduct{ }• 避免缩写:除非是广泛认可的缩写,否则尽量避免使用缩写。
• 避免仅靠大小写区分标识符:例如,不要同时使用int x和int X。
• 避免在不同作用域中重名:例如,不要在局部变量和全局变量中使用相同的名称。
• 复数类型命名:集合或数组优先使用复数形式,例如userNames或userNameList。
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)
规则:
• 在变量名前添加前缀,表示变量的类型或用途。例如:
• intCount(表示一个整型变量)
• strName(表示一个字符串变量)
8.6 其他命名规则• Kebab Case(短横线命名法):
• 单词之间用短横线 -分隔,常用于 HTML 类名、CSS 属性等。例如:first-name、calculate-total-price。
• Upper CamelCase(大驼峰命名法):
• 与帕斯卡命名法类似,但通常用于特定场景,如某些语言的模块名或包名。
来源:opendotnet