everything-claude-code/docs/zh-CN/rules/csharp/coding-style.md

paths

paths
**/*.cs **/*.csx

C# 编码风格

本文档扩展了 common/coding-style.md 中关于 C# 的特定内容。

标准

• 遵循当前的 .NET 约定并启用可为空引用类型
• 在公共和内部 API 上优先使用显式访问修饰符
• 保持文件与其定义的主要类型对齐

类型与模型

• 对于不可变的值类型模型，优先使用 record 或 record struct
• 对于具有标识和生命周期的实体或类型，使用 class
• 对于服务边界和抽象，使用 interface
• 避免在应用程序代码中使用 dynamic；优先使用泛型或显式模型

public sealed record UserDto(Guid Id, string Email);

public interface IUserRepository
{
    Task<UserDto?> FindByIdAsync(Guid id, CancellationToken cancellationToken);
}

不可变性

• 对于共享状态，优先使用 init 设置器、构造函数参数和不可变集合
• 在生成更新状态时，不要原地修改输入模型

public sealed record UserProfile(string Name, string Email);

public static UserProfile Rename(UserProfile profile, string name) =>
    profile with { Name = name };

异步与错误处理

• 优先使用 async/await，而非阻塞调用如 .Result 或 .Wait()
• 通过公共异步 API 传递 CancellationToken
• 抛出特定异常并使用结构化属性进行日志记录

public async Task<Order> LoadOrderAsync(
    Guid orderId,
    CancellationToken cancellationToken)
{
    try
    {
        return await repository.FindAsync(orderId, cancellationToken)
            ?? throw new InvalidOperationException($"Order {orderId} was not found.");
    }
    catch (Exception ex)
    {
        logger.LogError(ex, "Failed to load order {OrderId}", orderId);
        throw;
    }
}

格式化

• 使用 dotnet format 进行格式化和分析器修复
• 保持 using 指令有序，并移除未使用的导入
• 仅当表达式体成员保持可读性时才优先使用