SuperAPI AI 工具集

swift-docc

写作与研究

查看项目

更新于 10-16 07:23

技能介绍

用途:为 Swift 框架或包生成 API 参考文档与交互式教程,基于 DocC 官方文档标记与语法。

主要能力:从源码注释创建开发者文档并添加带代码片段的文章;为符号编写参考文档;向文档目录添加补充内容(文章与扩展文件);链接符号与其他内容以支持页面导航;添加代码片段;为可从多种源语言调用的 API 编写文档;格式化内容、添加数据表格、图片及其他页面元素;为文档页面添加结构(分组与集合);自定义页面外观;将文档分发到 Web 服务器;编写 API 参考文档与交互式教程。

使用方式:资料按从入门到进阶组织,建议先阅读 Introduction 或 Getting Started 部分,再查阅具体指南获取细节。内容包含 Essentials、Documentation Content、Structure and Formatting、Distribution、Documentation Types、Shared Syntax 等章节,涉及 documenting-a-swift-framework-or-package.md、writing-symbol-documentation-in-your-source-files.md、adding-supplemental-content-to-a-documentation-catalog.md、linking-to-symbols-and-other-content.md、adding-code-snippets-to-your-content.md、formatting-your-documentation-content.md、adding-tables-of-data.md、adding-images.md、adding-structure-to-your-documentation-pages.md、customizing-the-appearance-of-your-documentation-pages.md、distributing-documentation-to-other-developers.md、api-reference-syntax.md、tutorial-syntax.md 等文件。

适用场景:Swift 框架或包的 API 文档编写、教程制作、文档站点构建与分发。

限制:资料未提供具体安装命令、收费信息、平台支持范围或效果说明;本技能内容由 DocC 文档格式转换而来。