swift - 修复 Xcode 快速帮助检查器的参数部分中的“无描述”
问题描述
我在文档注释中使用标记在 Xcode 的快速帮助检查器中创建渲染文档。
在快速帮助检查器的“参数”部分,渲染器不断为名为“-”的参数添加“无描述”行,即使我已经为所有参数提供了描述,并且没有名为“-”的参数。
这是代码:
struct Carrot {
/**
Picks carrots.
- Parameters:
- qty: how many carrots to pick
- queue: The dispatch queue on which to run `done`.
- done: Code to run when done.
*/
public static func pick(_ qty: Int,
queue: DispatchQueue = DispatchQueue.main,
done: @escaping ([Carrot]) -> Void) {
// Code goes here.
}
}
代码的屏幕截图,因为我的代码在 Xcode 中的显示方式很重要:
这是快速帮助中呈现的帮助的样子:
请注意“参数”部分下的最后一个条目:“无描述”。我如何解决它?
我想也许这个问题是由于没有描述闭包输入参数,但如果这是原因,我一直无法找出正确的语法来使用。
我可以在 Xcode 的文档注释标记上找到的唯一文档是“已归档”,但似乎仍然受到 Xcode 10.2 的尊重。但是,我在这些文档中找不到任何东西来帮助我解决这个问题。
解决方案
推荐阅读
- python - 并发删除并放入 aws s3 存储桶
- excel - 如果嵌套在另一个公式中,如何在日期范围之间进行计数?
- oracle - 用于跨 dwh 模式识别电子邮件地址的 Oracle 查询逻辑
- powershell - Powershell:Ps1 脚本中的函数提示
- python - 从数据转换为图形坐标
- python - 以列表列表为值过滤字典
- javascript - 未从 html 按钮单击事件调用的 java 脚本函数
- django - Django 管理表单处理文件上传:“InMemoryUploadedFile”对象没有属性“宽度”
- java - 使用 CorsFilter 和 spring security 时出现 Cors 错误
- php - 动态 301 重定向