csharp

最近更新: 2025-10-10

C#/.NET 专属实践规范

1. 命名规范

1.1 类和接口

// 类名使用 PascalCase
public class UserService { }

// 接口以 I 开头
public interface IUserRepository { }

// 抽象类可以 Abstract 开头或结尾
public abstract class AbstractUserService { }

1.2 方法和属性

// 方法名使用 PascalCase
public async Task<User> GetUserByIdAsync(int userId) { }

// 属性使用 PascalCase
public string UserName { get; set; }

// 私有字段使用 camelCase 或 _camelCase
private readonly ILogger _logger;
private string userName;

1.3 常量和枚举

// 常量使用 PascalCase
public const int MaxRetryCount = 3;

// 枚举使用 PascalCase
public enum UserStatus
{
    Active,
    Inactive,
    Suspended
}

2. 异步编程

2.1 异步方法规范

// 异步方法以 Async 结尾
public async Task<string> GetDataAsync()
{
    // 使用 ConfigureAwait(false) 避免死锁
    var result = await httpClient.GetStringAsync(url).ConfigureAwait(false);
    return result;
}

// 避免 async void，除了事件处理器
public async void Button_Click(object sender, EventArgs e) // 仅限事件处理
{
    await ProcessAsync();
}

2.2 取消令牌

public async Task<User> GetUserAsync(int id, CancellationToken cancellationToken = default)
{
    return await repository.GetByIdAsync(id, cancellationToken);
}

3. 错误处理

3.1 异常处理

// 使用具体的异常类型
public User GetUser(int id)
{
    if (id <= 0)
        throw new ArgumentException("用户ID必须大于0", nameof(id));
    
    var user = repository.GetById(id);
    if (user == null)
        throw new UserNotFoundException($"未找到ID为{id}的用户");
    
    return user;
}

3.2 使用 Result 模式

public class Result<T>
{
    public bool IsSuccess { get; }
    public T Value { get; }
    public string Error { get; }
    
    private Result(bool isSuccess, T value, string error)
    {
        IsSuccess = isSuccess;
        Value = value;
        Error = error;
    }
    
    public static Result<T> Success(T value) => new(true, value, null);
    public static Result<T> Failure(string error) => new(false, default, error);
}