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

评审检查清单

F#

语言与脚本24 个检查项6 个章节
**/*.{fs,fsi,fsx}
精确优先于召回:只报告可能造成错误行为、安全漏洞、资源泄漏或实质性性能问题的缺陷。不要报告 Fantomas 能修复的格式问题,也不要用个人偏好取代项目既定的 F# 风格。本规则覆盖 F# 实现(.fs)、签名(.fsi)与脚本(.fsx)文件;提出兼容性发现之前,先确认目标框架及周边的 .NET API。
01

可辨识联合与模式匹配

5 项
  • match 表达式遗漏了可达的可辨识联合或 option 分支,尤其是在联合类型新增分支之后;不要报告编译器可证明穷尽的 match
    内置
    来源与改动说明

    来源

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

  • 仅用于压制不完整模式警告的兜底 _ 分支,而被遗漏的分支本需要不同的行为或错误处理
    内置
    来源与改动说明

    来源

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

  • 活动模式或守卫的排列顺序遮蔽了后面可达的分支,静默选中错误分支
    内置
    来源与改动说明

    来源

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

  • 对运行时、外部或不可信输入可能产生 None、ValueNone 或 Error 的场景,使用 Option.get、ValueOption.get、访问 option/value option 的 .Value,或项目中自定义的部分 Result 解包
    内置
    来源与改动说明

    来源

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

  • 把领域失败当作异常处理,而调用方本应通过 Result 处理;不要标记有明确文档说明、有意为之的异常边界
    内置
    来源与改动说明

    来源

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

02

资源生命周期与可变状态

4 项
  • 获取 IDisposable、流、数据库连接、锁或取消注册时,未使用 use、use!、try/finally 或能覆盖异常与提前返回的等价清理路径
    内置
    来源与改动说明

    来源

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

  • 资源从 use 作用域中被返回;被存活期超过该作用域的闭包捕获;或在仍消费它的异步工作流完成之前就被释放
    内置
    来源与改动说明

    来源

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

  • 在 agent、任务、事件回调或并行集合操作之间共享可变状态,却没有同步机制或清晰的单所有者协议
    内置
    来源与改动说明

    来源

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

  • 跨异步操作复用可变缓冲区、数组或记录,后续修改可能与消费方发生竞态;没有逃逸引用的普通局部修改不算发现
    内置
    来源与改动说明

    来源

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

03

异步、任务与取消

4 项
  • Task 或 Async 工作流丢弃了可达的异常、取消或结果,而不是在边界处传播或有意处理
    内置
    来源与改动说明

    来源

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

  • 在可能需要异步推进的上下文中调用 .Result、.Wait() 或 Async.RunSynchronously,带来死锁或线程池饥饿风险
    内置
    来源与改动说明

    来源

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

  • 接收了 CancellationToken 却未将其传入可取消的 I/O、延迟、HTTP、数据库或子任务操作(当 API 支持时)
    内置
    来源与改动说明

    来源

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

  • 启动后台工作后未保留、等待、监督或观察任务异常;对于生命周期与错误上报均已明确的有意分离(detached)进程,不要标记
    内置
    来源与改动说明

    来源

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

04

序列、集合与性能

4 项
  • 带副作用或来源昂贵的 seq 被多次枚举,而结果本应稳定,或重复执行会改变行为;仅当代码需要反复遍历时才要求物化一次
    内置
    来源与改动说明

    来源

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

  • 在未确认集合/键必然存在的情况下,对非常量输入调用 Seq.head、Seq.reduce、索引访问或 map 查找
    内置
    来源与改动说明

    来源

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

  • 在热点路径中意外强制求值惰性序列;或组合出的序列管道让延迟异常逃逸出承诺即时校验的边界
    内置
    来源与改动说明

    来源

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

  • 在循环中做平方级列表追加、反复更新不可变 map 或反复拼接字符串,且输入规模可能使开销变得显著;不要仅为微优化而替换简洁的集合代码
    内置
    来源与改动说明

    来源

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

05

.NET 互操作与类型边界

4 项
  • 把 F# 的 option 值当作 null 传给 .NET API;或在没有局部不变式的情况下把 .NET 的可空/引用返回值当作非空
    内置
    来源与改动说明

    来源

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

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

    来源

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

  • 未在局部确立运行时类型/可空性不变式时,使用运行时向下转型或产生未检查/默认值的操作(:?>、unbox、Unchecked.defaultof 或基于反射的调用)
    内置
    来源与改动说明

    来源

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

  • 不可信值未经校验或参数化即流入 SQL、shell 命令、文件路径、URL、反序列化或 HTML;以及密钥被写入源码、日志或错误消息
    内置
    来源与改动说明

    来源

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

06

签名与模块边界

3 项
  • .fsi 签名暴露的类型、元数、泛型约束、可变性或可见性与实现或预期的公共 API 不匹配
    内置
    来源与改动说明

    来源

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

  • 公共函数泄漏了可变的实现状态或内部表示,使调用方可能破坏模块的不变式
    内置
    来源与改动说明

    来源

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

  • 模块初始化带有可观察的 I/O、非确定性全局状态或异常,使导入该模块意外失败;不要报告显式且有文档说明的应用引导代码
    内置
    来源与改动说明

    来源

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

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

手动复制规则链接

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