Xcode 中的 Swift 文档：函数的多行描述答案

【问题标题】：Swift documentation in Xcode: Multi-line description for functionXcode 中的 Swift 文档：函数的多行描述
【发布时间】：2019-06-04 12:41:46
【问题描述】：

我正在使用 Xcode 10 和 Swift 5：

我的代码中有几个大函数需要详细的多行描述。示例：

/**
This is paragraph 1.

This is paragraph 2.

This is paragraph 3.
*/
func Foo() {
    //Bla
}

Xcode 创建的内容：

第 2 段和第 3 段是第 1 段的延续，因此将它们放在不同的部分很烦人。

如何将所有三个段落保留在同一部分中（我不在乎是“摘要”、“描述”……一个）？

我知道文档文档here，但没有说明如何准确执行此操作，并且是多行注释的唯一示例（向下滚动到：“调用此方法会增加”...）在“文档”弹出窗口的屏幕截图中缺少这行文本。

编辑： 如果你使用这样的列表更糟糕，因为标题留在“摘要”部分，而列表项被推到“讨论”部分：

/**
List Title:
- Item 1
- Item 2
- Item 3
*/

【问题讨论】：

【解决方案1】：

Xcode 总是将第一段解释为摘要，之后的所有内容都解释为讨论。摘要也将在空间较小的上下文中使用。例如作为代码完成的提示。这是一篇很好的博客文章，对我有帮助：https://sarunw.com/posts/swift-documentation/

【讨论】：