c# 代码规范

编写一致、清晰和易于理解的代码是一个团队协作的关键方面。

命名规范

命名规则

类名使用 PascalCase：MyClass方法名使用 PascalCase：MyMethod变量名使用 camelCase：myVariable常量名使用大写蛇形命名法：MY_CONSTANT

避免单个字符的变量名，除非是循环索引。

有意义的命名，避免缩写除非是广泛接受的缩写。

代码结构

使用大括号，即使只有一行代码。这有助于提高可读性，并防止错误。

csharp
if (condition)
{
    // Code
}

每行一个语句，避免在一行中写多个语句。

csharp
// 不推荐
int x = 5; int y = 10;

// 推荐
int x = 5;
int y = 10;

缩进使用四个空格，而不是制表符。

注释

使用XML注释，为公共API添加有用的文档。

csharp
/// <summary>
/// This is a summary of the method.
/// </summary>
/// <param name="param">Description of the parameter.</param>
/// <returns>Description of the return value.</returns>
public int MyMethod(int param)
{
    // Code
}

避免不必要的注释，良好的代码应该是自说明的。

异常处理

尽早抛出异常，在检测到无法处理的条件时。

使用具体的异常类型，而不是通用的Exception。

不要捕获所有异常，只捕获你能处理的异常。

其他

使用var关键字，当初始化表达式提供足够的信息时，可以使用var来提高可读性。

csharp
var myVariable = GetMyVariable();

使用readonly关键字，在可能的情况下使用readonly修饰字段。

csharp
private readonly int myReadOnlyField;

避免魔法数字，使用常量或枚举来代替硬编码的数字。

csharp
// 不推荐
if (status == 1)

// 推荐
if (status == Status.Active)

类和成员的排列顺序

成员的排列顺序：按照

使用断言，使用断言库来编写清晰的测试断言。

csharp
// NUnit 示例
Assert.AreEqual(expected, actual);

可读性和一致性

代码行长度，保持适度的代码行长度，通常建议不超过80-120个字符。

删除不必要的代码，定期清理不再使用的代码，保持代码库的整洁。

使用空格，在运算符和关键字周围使用空格，增强可读性。

csharp
int result = a + b;

这些规范是一些建议，可以根据项目和团队的需要进行调整。在团队内部，最好形成一致的编码标准，并确保团队成员