C# 代码命名规范与大小写约定详解

一只小鹿
一只小鹿
发布时间:2026-10-15| 5人浏览过
原创

在 C# 开发中,遵循统一的命名规范是提升代码可读性和可维护性的关键。本文整理了微软推荐的帕斯卡(Pascal)和驼峰(Camel)命名法则,明确各类标识符的大小写要求,并提供实用的编码最佳实践。

C# 核心命名规则

C# 的命名约定主要基于 PascalCasing 和 camelCasing 两种方式,这也是 .NET 类库的标准实践:

  • PascalCasing:标识符的第一个单词的首字母大写,后续单词首字母也大写。
  • camelCasing:标识符的第一个单词的首字母小写,后续单词首字母大写。

标识符大小写对照表

不同类型的标识符应遵循特定的大小写格式,具体规则如下:

标识符类型 命名风格 示例代码
命名空间 (Namespace) Pascal namespace Com.Techstar.ProductionCenter
类 (Class) Pascal public class DevsList
接口 (Interface) Pascal public interface ITableModel
方法 (Method) Pascal public void UpdateData()
属性 (Property) Pascal public int Length { get; set; }
事件 (Event) Pascal public event EventHandler Changed;
私有字段 (Private Field) Camel private string _fieldName;
公有/非私有字段 Pascal public string FieldName;
枚举值 (Enum Value) Pascal FileMode.Append
参数 (Parameter) Camel UpdateData(string fieldName)
局部变量 (Local Variable) Camel string fieldName;

注意:私有字段推荐使用 _ 前缀配合驼峰命名(如 _fieldName),这是微软常用的做法,有助于区分成员变量和局部变量。接口名称通常以大写 I 开头。

常见术语与缩写处理

缩写词的大小写规范

在 C# 中,缩写词的使用需谨慎,仅在公众广为认知时使用(如 ID, OK, UI)。处理方式取决于缩写长度及位置:

  • 两字符缩写:两个字母均大写。例如:DbConnectionString(Pascal)、dbServer(Camel)。
  • 长缩写(≥3字符):仅首字母大写。例如:XmlReader(Pascal)、xmlStream(Camel)。
  • 特殊缩写:ID 应写为 Id,OK 应写为 Ok。

复合词与常用术语

对于紧凑格式的复合词(如 endpoint),视为一个单词处理,按 Pascal 或 Camel 规则统一格式化。以下术语在 Pascal 格式下保留内部大写字母以体现词根结构:

  • BitFlag / bitFlag
  • FileName / fileName
  • LogOff / logOff
  • UserName / userName

良好编码习惯总结

除了大小写规范,以下 C# 编码习惯有助于提升代码质量:

  1. 自定义属性:以 Attribute 结尾,如 AuthorAttribute。
  2. 自定义异常:以 Exception 结尾,如 AppException。
  3. 方法命名:使用动宾短语,清晰表达动作,如 ShowDialog、CreateFile。
  4. 缩进格式:建议配置编辑器使用 Tab 键缩进(实际由空格模拟显示),保持团队一致。
  5. 变量命名:避免无意义的单字母(除循环变量 i, j 等),确保名称具有描述性。
  6. 代码组织:将类成员声明置于顶部,与方法逻辑用空行分隔;利用 #region 折叠相似内容。
  7. 字符串构建:在循环或多次拼接场景下,优先使用 StringBuilder 而非直接使用 + 操作符,以提升性能。
  8. 条件语句:即使 if 后只有一条语句,也必须使用花括号 {} 包裹,防止后期维护出错。

注意事项

CLR 支持区分大小写和不区分大小写的语言混合运行。上述大小写准则旨在提高代码的可读性和一致性,不应作为避免命名冲突的依据。在实际项目中,还应结合项目具体的 Code Style 工具或 IDE 设置进行自动化检查。

以上就是 C# 代码大小写规范与命名约定的详细内容,更多关于 C# 编程技巧的资料请关注本站其它相关文章!

免责声明:本文内容仅供参考,不代表本站观点。转载或引用请注明出处。

Python 相关产品和应用

全部下载
Selenium

Selenium

4.51.0 · Windows

用于浏览器自动化和 Web 测试的 Python 工具。

scikit-learn

scikit-learn

1.9.1 · Windows

常用 Python 机器学习算法与模型评估工具库。

Black

Black

26.10.1 · Windows

强调一致性的 Python 自动代码格式化工具。

Ruff

Ruff

0.17.1 · macOS

由 Rust 编写的高速 Python 代码检查和格式化工具。

pytest

pytest

9.1.1 · Windows

简洁而强大的 Python 自动化测试框架。

FastAPI

FastAPI

0.146.0 · Windows

高性能 Python API 框架,支持类型提示和自动接口文档。

Flask

Flask

3.1.3 · Windows

轻量灵活的 Python Web 应用框架。

Django

Django

6.1.2 · Windows

成熟的 Python Web 框架,适合构建内容站点和业务系统。

Spyder

Spyder

6.1.7 · Windows

面向科学计算与数据分析的 Python 集成开发环境。

SciPy

SciPy

1.18.1 · Windows

面向科学、工程和技术计算的 Python 算法库。