.NET C# 编码规范详解
需积分: 3 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个空格或制表符进行缩进。
- **注释**:推荐使用`//`单行注释或`///`文档注释,避免使用旧式的星号框注释。
- **变量**:每个声明应声明一个变量,避免冗余。
遵循这些规范有助于创建一致、易于理解的代码,减少潜在的错误,提高团队协作效率。在实际编程中,开发人员应将这些规则视为最佳实践,根据具体项目需求进行适当的调整。
2010-01-19 上传
2010-02-22 上传
2009-09-02 上传
2011-01-09 上传
2009-11-14 上传
2012-09-26 上传
2011-09-20 上传
2007-12-17 上传
2011-04-05 上传
兵的N维空间
- 粉丝: 23
- 资源: 72
最新资源
- BottleJS快速入门:演示JavaScript依赖注入优势
- vConsole插件使用教程:输出与复制日志文件
- Node.js v12.7.0版本发布 - 适合高性能Web服务器与网络应用
- Android中实现图片的双指和双击缩放功能
- Anum Pinki英语至乌尔都语开源词典:23000词汇会话
- 三菱电机SLIMDIP智能功率模块在变频洗衣机的应用分析
- 用JavaScript实现的剪刀石头布游戏指南
- Node.js v12.22.1版发布 - 跨平台JavaScript环境新选择
- Infix修复发布:探索新的中缀处理方式
- 罕见疾病酶替代疗法药物非临床研究指导原则报告
- Node.js v10.20.0 版本发布,性能卓越的服务器端JavaScript
- hap-java-client:Java实现的HAP客户端库解析
- Shreyas Satish的GitHub博客自动化静态站点技术解析
- vtomole个人博客网站建设与维护经验分享
- MEAN.JS全栈解决方案:打造MongoDB、Express、AngularJS和Node.js应用
- 东南大学网络空间安全学院复试代码解析