审查 Elixir 代码的惯用模式、OTP 基础和文档。用于审查 .ex/.exs 文件、检查模式匹配、GenServer 使用等。
Elixir 代码回顾 QQ快速引用 问题类型 参考 南明 格式化 模块结构 参考/代码风格 . md. 与条款, 守护, 解结构 参考/ 模式- 匹配. md
功能概述
Elixir 代码回顾 QQ快速引用 问题类型 参考 南明 格式化 模块结构 参考/代码风格 . md. 与条款, 守护, 解结构 参考/ 模式- 匹配. md是一项面向实际任务的技能，主要用于GenServer, Su.。它将相关步骤、工具调用和结果整理方式集中到统一流程中，帮助使用者更快完成目标并减少重复操作。
核心要点
- 使用时应结合输入条件选择合适的执行方式，核对必要参数、依赖环境与输出内容，并按原始要求处理异常情况。
- 该技能适合需要稳定复用相关能力的场景，可作为自动化工作流的一部分，也便于后续检查、调整和扩展。
- 从功能定位来看，该技能强调把分散的操作要求整理成清晰、可复用的处理流程，使用户能够围绕既定目标快速准备输入、选择执行方式并获得结构化结果。
使用与执行
实际使用前应先确认任务范围、数据来源、运行环境、必要权限和关键参数，再依据技能说明逐步执行；若输入条件不完整，应先补齐信息或采用保守配置，避免因错误假设导致结果偏离需求。
结果检查与注意事项
执行过程中需要关注工具调用是否成功、接口或依赖是否可用、输出格式是否符合预期，并对异常提示、缺失字段和边界情况进行处理；涉及批量任务时，还应保存进度，避免中断后重复操作。
Elixir 代码审查
快速参考
| 问题类型 | 参考文档 |
|---|---|
| 命名、格式化、模块结构 | references/code-style.md |
| with 子句、守卫（guards）、解构（destructuring） | references/pattern-matching.md |
| GenServer、Supervisor、Application | references/otp-basics.md |
| @moduledoc、@doc、@spec、doctest | references/documentation.md |
审查清单
代码风格
- 模块名使用 CamelCase，函数名使用 snake_case
- 管道链（pipe chain）应以原始数据开头，而非函数调用
- 私有函数置于公有函数之后并分组组织
- 无参函数调用中不使用不必要的括号
模式匹配
- 在适用场景下，优先使用模式匹配而非条件语句
- with 子句需包含 else 分支以处理错误情况
- 在可能情况下，使用守卫（guards）替代运行时检查
- 解构（destructuring）应在函数头中完成，而非函数体内部
OTP 基础
- GenServer 在初始化开销较大时应使用 handle_continue
- Supervisor 应采用合适的重启策略
- GenServer 回调中不得包含阻塞式调用
- 正确区分 call（同步）与 cast（异步）的使用场景
文档
- 所有公有函数均需配备 @doc 和 @spec
- 模块需包含 @moduledoc，说明其用途
- 对纯函数，在适当情况下编写 doctest
- 不得对真正公有的函数标注 @doc false
安全性
- 禁止对用户输入调用
String.to_atom/1（应使用to_existing_atom/1） - 禁止对不可信输入调用
Code.eval_string/1 - 禁止在未指定
:safe选项的情况下调用:erlang.binary_to_term/1
允许的模式（请勿标记）
- 为空值模式匹配定义空函数子句 ——
def foo(nil), do: nil是合法的守卫用法 - 单次转换时使用
|>—— 属于可读性权衡，不视为错误 - 回调实现中标注
@doc false—— 行为规范（behaviour）层面已统一文档化 - 私有函数未标注 @spec —— @spec 对内部实现为可选
- 使用
Kernel.apply/3—— 在模块/函数确定的前提下，适用于动态分发场景
上下文敏感规则
| 问题 | 仅当满足以下条件时标记 |
|---|---|
| 缺少 @spec | 该函数为公有函数且已导出（exported） |
| 泛化异常捕获（generic rescue） | 存在更具体的异常类型可供捕获 |
| 嵌套的 case/cond | 嵌套深度超过 2 层 |
何时查阅参考文档
- 审查模块/函数命名 → code-style.md
- 审查 with/case/cond 语句 → pattern-matching.md
- 审查 GenServer/Supervisor 相关代码 → otp-basics.md
- 审查 @doc/@moduledoc → documentation.md
上报前须通过的校验关卡（Gates）
请按以下顺序对本次审查批次执行全部步骤。任一关卡未通过前，不得发布任何发现结果。
- 协议已加载 —— 阅读 review-verification-protocol，并对其涵盖的每一类发现（如：未使用代码、验证缺失、安全风险、性能问题等）执行对应检查。通过标准：对每一项实质性发现，须明确指出所满足的协议子章节；若不适用，则须注明 N/A 并说明原因（例如：纯属风格问题）。
- 证据定位明确 —— 通过标准：每项发现均需提供具体定位信息：如
path:line（或行号范围），或Module.function/arity加上文件中的简短引用片段。 - 主张有依据支撑 —— 对于“未使用代码”、“缺失验证”或“安全风险”等断言，通过标准：须附上支撑性工件（例如：搜索结果、文件读取范围等）；若无法提供，则须将该项降级为明确标注的 疑问 或 存疑 条目，并说明未验证的内容。
提交发现前的必要步骤
请首先完成上方 Gates — before reporting 全部步骤；验证协议是执行这些关卡的强制前置输入。
相关专题
Vite项目打包部署专题汇集生产构建、产物预览、输出目录、资源路径、Nginx与GitHub Pages部署及常见白屏和路由404问题的已审核文章，帮助读者完成上线流程。
2026.10.28
0
16
Vite搭配Vue.js专题汇集创建Vue 3项目、配置开发环境、路径别名、Vue插件、代理、多环境构建与调试的已审核文章，帮助读者完成从初始化到日常开发的配置。
2026.10.28
0
15
Vite项目目录专题汇集入口文件、src源码、public静态资源、路径别名、项目根目录和构建输出目录相关的已审核文章，帮助读者理解各文件夹的用途与引用方式。
2026.10.28
0
10
本专题介绍Gradle插件开发的基本流程，涵盖插件类编写、自定义任务注册、扩展参数设计和插件应用方法，帮助你理解插件如何组织构建逻辑，减少多个项目之间的重复配置。
2026.10.22
0
11
本专题介绍Gradle Wrapper的基本作用，涵盖文件组成、生成方法、版本配置和任务调用，帮助你理解项目如何使用指定的Gradle版本，减少不同开发环境带来的构建差异。
2026.10.22
0
10
本专题整理Golangci-lint常用Linters的用途与配置方法，覆盖错误处理、无效代码、安全、复杂度、命名和依赖检查，帮助项目合理选规则。
2026.10.22
0
15
本专题介绍Gradle Java项目构建方法，涵盖Java插件配置、依赖声明、源码编译、测试执行和打包检查，帮助你理解各阶段的任务关系，逐步完成项目构建。
2026.10.22
0
10
本专题汇总PHP常见时间戳漏洞，包括2038年溢出、时区漂移、时间戳伪造、重放攻击、时间盲注与日志审计失效等，并给出升级64位环境、使用 DateTimeImmutable、统一UTC、严格超时校验、预处理绑定、hash_equals 比对等修复方案，帮助开发者快速排查和加固时间相关代码。
2026.10.22
0
25
本专题聚焦Golangci-lint YAML配置文件，讲清运行参数、规则启停、目录排除、问题过滤及严重级别设置，便于团队统一检查标准。
2026.10.22
0
15
热门下载
相关下载
精品课程
共6课时 | 54.7万人学习
共89课时 | 134.1万人学习
共49课时 | 82.6万人学习
最新文章