.NET C# 编码规范详解

需积分: 3 1 下载量 140 浏览量 更新于2024-09-18 收藏 79KB DOC 举报
“C#编程规范01” C#编程规范是.NET开发者遵循的一套规则,旨在提高代码质量、可读性和可维护性。规范涵盖了命名约定、访问修饰符的使用、编码风格等多个方面。 1. **访问修饰符**:C#中的访问修饰符包括`public`、`protected`、`internal`和`private`。`private`是最常见的,用于限制成员在类内部的访问。接口和枚举默认为`public`,允许外部访问。 2. **命名约定**: - **骆驼命名法 (CamelCase)**:通常用于变量名,其中第一个单词的首字母小写,后续单词的首字母大写,如`depName`。 - **帕斯卡命名法 (PascalCase)**:用于类型名,如类、接口、枚举等,每个单词首字母大写,如`MyClassOfPersonal`。 - **下划线前缀 (_c)**:在私有字段中使用,但不推荐使用匈牙利命名法(即使用首字母来表示变量类型)。 3. **命名总则**: - **项目文件、源文件和其他文件**:公共访问级别使用帕斯卡命名法,与项目、程序集或包含的类匹配。 - **命名空间**:同样使用帕斯卡命名法,与项目/程序集部分匹配。 - **类和结构**:所有级别都适用帕斯卡命名法,子类可以加后缀表示继承关系。 - **接口**:帕斯卡命名法,前缀大写字母"I"表示接口,如`IInterfaceName`。 - **方法**:使用动词或动词与对象组合,如`GetUserName`。 - **属性**:帕斯卡命名法,避免使用`Get`或`Set`作为前缀。 - **字段**:私有字段用下划线`_`开头,推荐使用骆驼命名法,不建议使用匈牙利命名法。 - **常量**:公共访问级别,私有字段用下划线`_`开头。 - **静态字段**:同上,仅限私有。 - **枚举**:帕斯卡命名法,枚举值也应遵循此规则。 - **委托**:帕斯卡命名法。 - **事件**:帕斯卡命名法。 - **参数**:无访问修饰符,但应清晰命名。 4. **编码风格**: - **源文件**:每个源文件包含一个命名空间和一个类。 - **大括号**:新的行开始大括号,可选时总是使用括号,即使语句可以省略。 - **缩进**:使用4个空格或制表符进行缩进。 - **注释**:推荐使用`//`单行注释或`///`文档注释,避免使用旧式的星号框注释。 - **变量**:每个声明应声明一个变量,避免冗余。 遵循这些规范有助于创建一致、易于理解的代码,减少潜在的错误,提高团队协作效率。在实际编程中,开发人员应将这些规则视为最佳实践,根据具体项目需求进行适当的调整。