C# 代码规范指南

为了提高代码的可读性、可维护性和可重用性,档将介绍一些编写规范 C# 代码的最佳实践。

命名规范

  • 使用 PascalCase 命名类和方法。
  • 使用 camelCase 命名局部变量和方法参数。
  • 使用有意义的、描述性的名称。

代码格式

  • 使用 4 个空格进行缩进。
  • 在运算符前后添加空格。
  • 每个语句独占一行。
  • 使用空行分隔逻辑代码块。

注释

  • 使用 XML 文档注释记录公共 API。
  • 为难以理解的代码添加注释。
  • 避免添加冗余或显而易见的注释。

其他最佳实践

  • 保持代码简洁易懂。
  • 遵循 SOLID 原则。
  • 编写单元测试以确保代码质量。
doc 文件大小:284.5KB