跳到正文
Code Review
← 规则库/语言与脚本

评审检查清单

C#

语言与脚本26 个检查项6 个章节
**/*.cs
求准不求全:只报告可能导致错误行为、安全漏洞、资源泄漏或实质性性能问题的缺陷。不要报告 dotnet format 能修复的格式问题、已由分析器或 .editorconfig 约束的命名选择,也不要以个人偏好替换项目既定的 C# 风格。本规则适用于 C# 源码(.cs)文件;在提出兼容性或可空性发现之前,先考虑目标框架、语言版本以及是否启用了可空引用类型。
01

可空性与引用类型

4 项
  • 对周围代码可能触达为 null 的值进行解引用,包括构造路径未赋值的字段、Try 调用失败后的 out 参数,或未经检查就使用的查找结果
    内置
    来源与改动说明

    来源

    本站调整:沿用原规则,提供中文说明并补充编号。

  • 对可空性未在本地得到确认的值使用 !(null 宽容运算符),或用它压制反映真实可达 null 的警告
    内置
    来源与改动说明

    来源

    本站调整:沿用原规则,提供中文说明并补充编号。

  • 公开 API 标注为不可空,而某条实现路径可能返回 null;或可空参数未经保护即被解引用。对于未启用可空引用类型的项目,不要报告注解问题
    内置
    来源与改动说明

    来源

    本站调整:沿用原规则,提供中文说明并补充编号。

  • as 转换后未做 null 检查即使用,而对该方法所接受的输入而言,转换失败是可达的
    内置
    来源与改动说明

    来源

    本站调整:沿用原规则,提供中文说明并补充编号。

02

资源生命周期与释放

4 项
  • 被评审代码拥有的 IDisposable 或 IAsyncDisposable —— 流、DbConnection、SemaphoreSlim、CancellationTokenRegistration、计时器 —— 未用 using、await using 或覆盖异常与提前返回的 try/finally 加以释放;由别处拥有的依赖(例如由容器注入并释放的作用域 DbContext)不属于本代码应释放的范围
    内置
    来源与改动说明

    来源

    本站调整:沿用原规则,提供中文说明并补充编号。

  • 一次性资源存入字段、或被闭包捕获而存活到释放它的作用域之后;或在仍在使用它的异步操作尚未完成时就被释放
    内置
    来源与改动说明

    来源

    本站调整:沿用原规则,提供中文说明并补充编号。

  • 拥有一次性资源的类型既未实现 IDisposable 也未实现 IAsyncDisposable,使调用方无从释放;实现其中任一接口即已足够,而仅将所有权转交给调用方的类型两者都不需要
    内置
    来源与改动说明

    来源

    本站调整:沿用原规则,提供中文说明并补充编号。

  • 每次请求都新建 HttpClient,而不是复用或从 IHttpClientFactory 获取,且套接字耗尽或 DNS 过期是现实可能的后果;控制台入口点中单个短生命周期的 client 不构成发现
    内置
    来源与改动说明

    来源

    本站调整:沿用原规则,提供中文说明并补充编号。

03

异步、Task 与取消

5 项
  • 在事件处理器之外使用 async void,导致调用方无法 await,抛出的异常也到达不了任何处理器
    内置
    来源与改动说明

    来源

    本站调整:沿用原规则,提供中文说明并补充编号。

  • 在可能需要异步推进的路径上使用 .Result、.Wait() 或 GetAwaiter().GetResult(),有死锁或线程池饥饿的风险
    内置
    来源与改动说明

    来源

    本站调整:沿用原规则,提供中文说明并补充编号。

  • 接受了 CancellationToken 却没有传入支持取消的 I/O、延迟、HTTP 或数据库调用
    内置
    来源与改动说明

    来源

    本站调整:沿用原规则,提供中文说明并补充编号。

  • 启动了 Task 却既不 await、不返回、也未安排能观察其异常的延续;对于刻意分离且生命周期与错误报告都很明确的操作,不要报告
    内置
    来源与改动说明

    来源

    本站调整:沿用原规则,提供中文说明并补充编号。

  • 并发延续、并行循环或事件回调在无同步的情况下触碰共享可变状态,包括多个 task 共用一个非线程安全集合
    内置
    来源与改动说明

    来源

    本站调整:沿用原规则,提供中文说明并补充编号。

04

LINQ、集合与枚举

4 项
  • 对 IEnumerable 多次枚举,而其来源是延迟查询、数据库调用或有副作用的操作,导致重复执行或两次结果不一致
    内置
    来源与改动说明

    来源

    本站调整:沿用原规则,提供中文说明并补充编号。

  • 对非常量输入,未确认元素或键存在就使用 First()、Single()、Last()、索引器或 Dictionary 键访问
    内置
    来源与改动说明

    来源

    本站调整:沿用原规则,提供中文说明并补充编号。

  • 延迟查询捕获了循环变量、已释放的上下文,或在枚举前被修改的状态,导致其求值对象与代码读到的并不一致
    内置
    来源与改动说明

    来源

    本站调整:沿用原规则,提供中文说明并补充编号。

  • 在外层循环的每个元素上执行一次查询,且数据量使往返开销变得实质;或 provider 已取回整表后才应用内存过滤。不要仅为微优化而重构可读性良好的查询代码
    内置
    来源与改动说明

    来源

    本站调整:沿用原规则,提供中文说明并补充编号。

05

相等性、结构与值语义

4 项
  • 重写了 Equals 却没有重写 GetHashCode(或相反);或二者基于可变状态实现,而实例又被用作字典键或集合成员
    内置
    来源与改动说明

    来源

    本站调整:沿用原规则,提供中文说明并补充编号。

  • 可变结构因复制而确实丢失写入 —— 通过 readonly 字段、in 参数或返回副本的集合索引器进行修改,使更新落在临时副本上并被丢弃;复制值类型并各自独立修改是 C# 的常规用法,其本身不构成发现
    内置
    来源与改动说明

    来源

    本站调整:沿用原规则,提供中文说明并补充编号。

  • 本意是值相等却使用了引用相等;或对运算符未按比较预期重载的类型使用 ==
    内置
    来源与改动说明

    来源

    本站调整:沿用原规则,提供中文说明并补充编号。

  • 在偏移量或时区有影响时使用 DateTime,或混用 Utc、Local 与 Unspecified Kind 的比较
    内置
    来源与改动说明

    来源

    本站调整:沿用原规则,提供中文说明并补充编号。

06

互操作、序列化与信任边界

5 项
  • 不可信值未经参数化、校验或编码即流入 SQL、shell 命令、文件路径、URL、LDAP 查询、反序列化或渲染的 HTML
    内置
    来源与改动说明

    来源

    本站调整:沿用原规则,提供中文说明并补充编号。

  • 秘钥、连接字符串或令牌被写入源码、日志或异常消息
    内置
    来源与改动说明

    来源

    本站调整:沿用原规则,提供中文说明并补充编号。

  • P/Invoke、反射或序列化绑定的声明类型、封送处理、可空性、所有权或枚举值与外部契约不匹配
    内置
    来源与改动说明

    来源

    本站调整:沿用原规则,提供中文说明并补充编号。

  • 反序列化器被配置为从不可信输入解析任意类型;或从请求绑定的模型暴露了端点并不打算接受的字段
    内置
    来源与改动说明

    来源

    本站调整:沿用原规则,提供中文说明并补充编号。

  • 捕获的异常被吞掉,或以 throw ex 方式重抛而丢弃原始堆栈跟踪,而该失败本应传播或被记录
    内置
    来源与改动说明

    来源

    本站调整:沿用原规则,提供中文说明并补充编号。

返回本页顶部 ↑继续浏览规则库

手动复制规则链接

浏览器未允许自动复制,请选中下方链接复制。