SuperAPI AI 工具集

swift-docc-comments

编程与开发

查看项目

更新于 10-16 06:19

技能介绍

用途:在编写或增强 Swift 源码的内联文档注释(DocC 生成用)时提供格式规范,也可用于为 Swift 源文件补充行内文档注释。

主要能力与结构:内联注释以三斜线 /// 书写。首段为摘要,一句话;其后为讨论段落,无需标题;代码示例使用三反引号包裹,放在参数说明之前;随后使用 - Parameter、- Returns、- Throws、- Note 等标记。符号链接使用双反引号 SymbolName,行内与目录文件均可使用。

使用方式与位置区分:## Overview 与 ## Topics 属于章节标题,只能放在 .docc 目录文件中,不能出现在 /// 内联注释里;内联注释中如需示例,直接写代码块,不要加 ## Example 标题。文档生成命令为:swift package generate-documentation。

常见错误:内联注释中出现 ## Overview 或 ## Topics;在代码块前加 ## Example;把 - Parameter 放在代码示例之前。资料中给出的“红旗”信号包括:/// 注释中出现 ## Overview、## Topics、代码块前的 ## Example,以及参数说明出现在代码示例之前。

限制:资料未提供除上述结构与命令之外的工具配置、平台或版本要求。