Codex Elixir 文档技能:给新模块补公开函数说明
EnglishCodex 安装步骤
- 从固定 GitHub 提交复制 `skills/elixir-phoenix-document/` 完整目录到项目 `.agents/skills/elixir-phoenix-document/`。
- 让 Codex 读取 `references/doc-templates.md` 和当前变更,列出新模块与公开函数。
中文摘要
对已确认的 Elixir 改动检查 `@moduledoc`、`@doc` 和示例覆盖,引用实际代码的参数及返回值。
SKILL.md 中文导读
可复现示例
为本地 `Catalog.Labels` 新模块的 `normalize/1` 写 `@moduledoc` 与 `@doc`。用一个已验证的去空格示例说明输入与输出。工作步骤
- 给公开入口写职责、参数与返回含义,对实际可运行示例补验证。
- 根据现有项目约定运行可用的文档测试,汇报只修改了哪些说明。
验收方法
文档与实际函数签名和返回值一致,示例对应可复查的测试。
GitHub 原文 · 更新日期
适用环境
需要本地 Elixir 项目、已完成的功能改动和明确的文档范围。
常见问题
应该自动给私有函数加 @doc 吗?
该工作流聚焦已确认范围内的新模块与公开函数。私有实现可按现有项目惯例写必要注释。
相关指南
相关推荐
Codex Phoenix 方案库技能:检索已解决问题并记录预防方法
ccarvalho-eng/codex-elixir-phoenix
Codex Ecto 迁移技能:拆分 PostgreSQL 新增列与回填
ccarvalho-eng/codex-elixir-phoenix
elixir-phoenix-brainstorm 技能
ccarvalho-eng/codex-elixir-phoenix
elixir-phoenix-brief 技能
ccarvalho-eng/codex-elixir-phoenix
elixir-phoenix-deploy 技能
ccarvalho-eng/codex-elixir-phoenix
Codex Oban 技能:验证 Elixir 后台任务可重复运行
ccarvalho-eng/codex-elixir-phoenix