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

Question

问题：

• 将文档（使用内置功能而非第 3 方）添加到 Xcode 8 中的自定义 Swift 闭包的正确 格式 是什么？
• 能否提供 Apple 文档 link 以供参考？
• 如何指定 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

参考：

• 参考 Markup Formatting Reference 即“格式化快速帮助”部分

解决方法：

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

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