用途:该技能面向 TypeScript/JavaScript 代码的文档工作,提供 TSDoc 格式模板、类型文档规范和维护流程。当编写或编辑函数、类型、模块的 TSDoc 注释,审查文档质量,创建 API 文档,或整理复杂类型结构时会被自动调用。主要能力:包含公共 API 函数、内部模块、公共与内部类型、辅助函数、行为式编程函数、特殊注解(安全、性能、弃用)以及类型文档(复杂对象、联合类型、函数、工具类型、品牌类型等)的模板;支持清理不合规注释(性能说明、时间戳、内联解释)、同步与代码变更不同步的 TSDoc、移除已删除代码的孤立文档。使用方式:依据 workflow.md 的生成工作流执行,分为四个阶段,其中第一阶段为类型分析、第二阶段为用法发现;维护时参考 maintenance.md 的清理与同步指南,模板文件包括 public-api-templates.md、internal-templates.md、type-documentation.md。相关技能 typescript-lsp 可用于文档流程中的类型验证与发现,运行 lsp-hover 验证签名,lsp-references 查找用法,lsp-symbols 了解文件结构。关键标准:不写 @example 段落,测试和 story 作为可运行的示例。限制:资料未说明具体支持的编辑器、平台、收费方式或安装命令,暂未提供。
code-documentation
写作与研究
更新于 10-16 08:06