Claude Code React API 参考写作技能:说明 Hook 参数、返回值和用法
EnglishClaude Code 安装步骤
- 打开固定版本的仓库工作副本,确认 `.claude/skills/docs-writer-reference/SKILL.md` 存在。
- 从仓库根目录启动 Claude Code,输入 `/docs-writer-reference` 并描述要处理的内容与验证目标。
中文摘要
根据 API 属于 Hook、组件、配置还是指令,选择 react.dev 对应参考模板。适合把参数、返回值、限制和常见用法分成可快速查阅的小节。
SKILL.md 中文导读
可复现示例
为一个虚构的 `useReadingFilter` Hook 写参考草稿。输入是记录列表与过滤选项,返回过滤结果。用切换已读状态作为最小示例。工作步骤
- 先确认 API 类型与真实签名,分开描述参数、返回值及注意事项。
- 选择一个可观察的用例,并为常见误用写清触发条件与修正方向。
验收方法
参考区给出签名、参数与返回值,使用区展示筛选变化。涉及未确认的排序规则时应标为待补。
GitHub 原文 · 更新日期
适用环境
Claude Code、固定版本 react.dev 工作副本和已确认的 API 契约。保留 docs-voice、docs-components、docs-sandpack 等相关技能。
常见问题
组件参考和 Hook 参考适合用同一模板吗?
先确定读者查什么。组件重点说明 props 和渲染行为,Hook 参考重点说明调用签名、返回值及使用限制。