swift - Xcode - 为 Swift 闭包添加自定义文档

Question

问题：

• 将文档（使用内置功能而不是第 3 方）添加到自定义闭包的正确格式是什么？SwiftXcode 8
• 您能否提供Apple 文档链接以供参考？
• 如何指定closure parameters？
• 如何指定closure return type？

例子：

struct S1 {

    /// This block is executed after completion
    var completion : (String, Int) -> (Bool)
}

笔记：

Xcode 8具有将文档添加到自定义代码的内置功能。

这可以通过执行以下操作之一来完成：

• Command++Option关于Click代码

• 将光标保持在代码上并Editor> Structure>Add documentation

Answer 1

参考：

• 有关参考，请参阅标记格式参考，即“格式化快速帮助”部分

解决方法：

如果给定位置不支持这些标签，则唯一可能的解决方法似乎是现在：

struct S1 {
    
    /// description
    ///
    /// __returns__
    /// blah blah
    ///
    /// __parameters__
    /// blah blah
    var completion : (String, Int) -> (Bool)
}