Xcode中的Swift文档:功能的多行描述

时间:2019-06-04 12:41:46

标签: swift xcode code-documentation

我在Swift 5中使用Xcode 10:

我的代码中有几个大功能需要详细的多行描述。示例:

/**
This is paragraph 1.

This is paragraph 2.

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

Xcode创建的内容:

enter image description here

第2款和第3款是第1款的延续,因此将它们放在不同的部分会很令人生气。

我如何将所有三个段落都放在同一部分中(我不在乎它是“摘要”,“描述” ...)?

我知道文档文档here,但没有确切说明如何执行此操作,也没有多行注释的唯一示例(向下滚动至:“调用此方法将递增”。) 。)在“文档”弹出窗口的屏幕截图中恰好缺少此行文本。

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

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

1 个答案:

答案 0 :(得分:0)

Xcode始终将第一段解释为摘要,并将其后的所有内容解释为“讨论”。该摘要还将在空间较小的情况下使用。例如,作为代码完成的提示。 这是一篇很好的博客文章,对我有帮助:https://sarunw.com/posts/swift-documentation/