SuperAPI AI 工具集

swift-docc-reference

编程与开发

查看项目

更新于 10-16 03:40

技能介绍

用途:指导用 Swift DocC 编写 API 参考文档,覆盖源码内文档注释、.docc 文档目录、主题编排、符号图以及 Xcode 智能体技能集成。

主要能力与参考文件:

  • references/doc-comments-standard.md:编写或审阅三斜线(///)源码文档注释、单句摘要、parameter/return/throws 标签及提示块格式时查阅。
  • references/symbol-curation-and-extensions.md:编排目标落地页、定义 ## Topics 层级、创建文档扩展文件(Extensions/<Type>.md)、解析符号链接与重载消歧时查阅。
  • references/article-and-metadata-directives.md:配置 @Metadata、@TechnologyRoot、@Redirected 重定向、@Row/@Column 多列网格、@TabNavigator 语言切换时查阅。

必要用法:源码注释优先用 /// 而非块注释,紧贴声明且不留空行;首段为摘要句,用现在时或名词短语,尽量一句且不超过 120 字符,与扩展讨论之间空一行 ///。参数、返回值、错误用标准 Markdown 列表标签(- Parameter:、- Returns:、- Throws:),可用分组 - Parameters: 块。提示块支持 Note、Important、Warning、Tip、Experiment。文档目录为 .docc 文件夹,含目标落地页、概念文章、扩展文件与资源。落地页一级标题格式为 # MyFramework。符号链接用双反引号,文章链接用 doc:...,重载可用符号种类、参数类型、返回类型或唯一哈希后缀消歧。以 ## Topics 编排符号可替代自动生成的分类。文档扩展文件内容与源码注释合并。DocC 基于 Swift 编译器产出的 Symbol Graph JSON,可执行 swift package dump-symbol-graph 将符号图输出至 .build/extracted-symbols/。Xcode 内置技能可用 xcrun agent skills export --output-dir /path/to/exported-skills 导出,但不含 DocC 相关技能。

适用场景:Swift 框架/库的 API 参考文档与概念指南编写、文档审阅与质量检查。

限制:具体平台版本要求、命令行工具完整参数、Xcode 内置技能数量与名称以实际环境为准;本技能本身是否开源、收费或价格暂未提供。安装与运行细节暂未提供。