关于 code-documentation
面向 TypeScript 开发者的 TSDoc 编写与维护技能，涵盖 API、类型和模块文档。它提供模板及生成、同步工作流，并规定以测试和 stories 作为示例，不使用 @example 段落。
主要功能
- 01API 与类型的 TSDoc 模板
- 02四阶段文档生成流程
- 03注释清理与同步指南
- 04删除孤立文档的指导
- 05不使用 @example 段落
适用场景
- 01编写公共 API 函数和类型文档
- 02审查或更新 TSDoc 注释
- 03代码变更后同步注释
安装
复制下面的命令，在终端中运行。
$
npx skills add https:/安装后在 Claude Code 中输入/code-documentation确认已加载。
包含的文件
除 SKILL.md 外，安装时一起下载的参考资料和脚本。
references/internal-templates.mdmaintenance.mdpublic-api-templates.mdtype-documentation.mdworkflow.md详细介绍
代码文档技能
用途
此技能提供 TSDoc 格式模板、类型文档编写指南和维护工作流。适用于以下情况：
- 为任何函数、类型或模块编写或编辑 TSDoc 注释
- 审查文档质量
- 创建完整的 API 文档
- 为复杂类型结构编写文档
- 清理不符合规范的注释（性能说明、时间戳、内联解释）
- 将未同步的 TSDoc 与代码更改保持同步
- 删除已删除代码的孤立文档
关键标准：不得包含 @example 章节——测试和故事是常设示例。
快速参考
- 创建 TSDoc：查看 workflow.md，了解生成工作流
- 维护 TSDoc：查看 maintenance.md，了解清理和同步指南
此技能包含以下内容的详细模板：
- 公共 API 函数
- 内部模块文档
- 公共和内部类型
- 辅助函数
- 行为编程函数
- 特殊注解（安全性、性能、弃用）
- 类型文档（复杂对象、联合类型、函数、工具类型、品牌类型等）
导航
- workflow.md - TSDoc 生成工作流（4 个阶段）
- maintenance.md - 注释规范、同步任务、孤立文档处理
- public-api-templates.md - 面向公众的 API 模板
- internal-templates.md - 内部代码和模块模板
- type-documentation.md - 完整的类型文档模板
相关技能
- typescript-lsp：在文档工作流中用于类型验证和发现。对于 TSDoc 生成流程的第 1 阶段（类型分析）和第 2 阶段（用法发现）至关重要。运行
lsp-hover验证签名，运行lsp-references查找用法，运行lsp-symbols了解文件结构。
评论
支持 Markdown