Codex Lithia.js JSDoc 编写｜说明注册范围、返回值与清理
EnglishCodex 安装步骤
- 打开 GitHub 固定提交的 `.agents/skills/write-jsdoc/SKILL.md`，核对内容与使用条件。
- 在自己的项目中创建 `.agents/skills/write-jsdoc/`，把核对后的文件保存为 `.agents/skills/write-jsdoc/SKILL.md`。
- 在该项目根目录启动 Codex，输入 `$write-jsdoc` 并选择同名技能。
中文摘要
读完 Lithia.js 接口和相关实现后，为生命周期、作用范围及清理等不易从签名看出的行为补写准确的 JSDoc。
SKILL.md 中文导读
可复现示例
按下面已核对的行为写一个拟议 API 的英文 JSDoc 草稿。
{"api":"registerFormatter","scope":"current app","registers":"report formatter","returns":"cleanup callback"}工作步骤
- 读取公开接口、周边实现和相关文档。
- 从代码确认作用范围、生命周期与副作用。
- 先用英文概括可观察行为，再对真实参数、返回值或错误添加标签。
验收方法
产出以 `Registers a report formatter for the current app.` 开头的英文 JSDoc，并用 `@returns` 解释返回 `cleanup callback`。
GitHub 原文 · 更新日期
适用环境
在 Codex 中打开 Lithia.js 工作区并提供要说明的接口。技能产出的 JSDoc 使用英文，可用中文说明需求。
常见问题
每个接口都需要写完整的标签吗？
选择能解释实际行为的标签。只有代码或约定确认会抛错时，才添加错误说明。