SuperAPI AI 工具集

code-documentation

编程与开发

查看项目

更新于 10-16 02:03

技能介绍

用途

code-documentation 技能用于 TypeScript/JavaScript 代码的文档编写与维护。根据资料,它提供 TSDoc 格式模板、类型文档编写指南以及维护工作流,并在编写、审查或编辑任何 TSDoc 注释、代码文档或 API 文档时自动被调用。

主要能力

该技能可用于以下场景:

  • 为任何函数、类型或模块编写或编辑 TSDoc 注释
  • 审查文档质量
  • 创建完整的 API 文档
  • 为复杂类型结构编写文档
  • 清理不符合规范的注释(如性能说明、时间戳、行内解释)
  • 将已与代码变更脱节的 TSDoc 重新同步
  • 删除已删除代码对应的孤立文档

该技能包含以下详细模板:

  • 公开 API 函数
  • 内部模块文档
  • 公开与内部类型
  • 辅助函数
  • 行为式编程函数
  • 特殊注解(安全、性能、已弃用)
  • 类型文档(复杂对象、联合类型、函数、工具类型、品牌类型等)

使用方式

根据资料,该技能通过以下文件组织内容:

  • workflow.md:TSDoc 生成工作流(4 个阶段)
  • maintenance.md:注释策略、同步任务、孤立文档处理
  • public-api-templates.md:面向公开 API 的模板
  • internal-templates.md:内部代码与模块的模板
  • type-documentation.md:全面的类型文档模板

其关键标准是:不使用 @example 段落——测试和 story 作为“活示例”。

资料还建议结合 typescript-lsp 技能使用:在文档工作流中进行类型验证与发现,尤其用于 TSDoc 生成流程的第 1 阶段(类型分析)和第 2 阶段(用法发现)。可运行 lsp-hover 验证签名、lsp-references 查找用法、lsp-symbols 理解文件结构。

适用场景

适用于需要为 TypeScript/JavaScript 项目编写、审查、维护 TSDoc 与 API 文档的开发者或团队,尤其是关注公开 API 文档、复杂类型文档以及注释与代码同步的场景。

限制

资料未提供该技能的安装命令、收费方式、价格、具体平台支持、实际效果数据或完整使用步骤,这些信息暂未提供。