SuperAPI AI 工具集

code-documentation

写作与研究

查看项目

更新于 10-16 03:43

技能介绍

用途:该技能为 TypeScript/JavaScript 代码提供 TSDoc 格式模板、类型文档编写指南与文档维护工作流,适用于编写或编辑函数、类型、模块的 TSDoc 注释,审查文档质量,创建完整 API 文档,记录复杂类型结构,清理不合规注释(如性能说明、时间戳、内联解释),同步与代码变更脱节的 TSDoc,以及移除已删除代码的孤立文档。

主要能力:包含公共 API 函数、内部模块文档、公共与内部类型、辅助函数、行为式编程函数、特殊注解(安全、性能、已弃用)以及类型文档(复杂对象、联合类型、函数、工具类型、品牌类型等)的详细模板。核心标准是不使用 @example 段落,测试与 stories 作为可运行的示例。

使用方式:生成 TSDoc 参见 workflow.md 的四阶段生成工作流;维护 TSDoc 参见 maintenance.md 的清理与同步指南。相关技能 typescript-lsp 可用于文档流程中的类型验证与发现,是 TSDoc 生成第一阶段(类型分析)和第二阶段(用法发现)的关键,可运行 lsp-hover 验证签名、lsp-references 查找用法、lsp-symbols 理解文件结构。

适用场景:需要统一 TSDoc 风格、提升 API 文档质量、保持文档与代码同步的 TypeScript/JavaScript 项目。

限制:资料未提供具体安装命令、收费方式、平台支持范围及实际效果数据,暂未提供。