Xcode中的Swift文档:函数的多行描述
我将Xcode 10与Swift 5配合使用: 我的代码中有几个大函数需要详细的多行描述。例如:Xcode中的Swift文档:函数的多行描述,swift,xcode,code-documentation,Swift,Xcode,Code Documentation,我将Xcode 10与Swift 5配合使用: 我的代码中有几个大函数需要详细的多行描述。例如: /** This is paragraph 1. This is paragraph 2. This is paragraph 3. */ func Foo() { //Bla } Xcode创建的内容: 第2段和第3段是第1段的延续,因此将它们放在不同的部分是令人恼火的 如何将所有三个段落保持在同一部分(我不在乎是否是“摘要”、“描述”…一) 我知道文档,但没有解释如何准确地执行此
/**
This is paragraph 1.
This is paragraph 2.
This is paragraph 3.
*/
func Foo() {
//Bla
}
Xcode创建的内容:
第2段和第3段是第1段的延续,因此将它们放在不同的部分是令人恼火的
如何将所有三个段落保持在同一部分(我不在乎是否是“摘要”、“描述”…一)
我知道文档,但没有解释如何准确地执行此操作,多行注释的唯一示例(向下滚动到:“调用此方法会增加”…)就是在“文档”弹出窗口的屏幕截图中缺少这行文本
编辑:
如果您使用这样的列表,情况会更糟,因为标题保留在“摘要”部分,而列表项被推到“讨论”部分:
Xcode总是将第一段解释为摘要,之后的所有内容都解释为讨论。摘要也将在空间较小的上下文中使用。例如,作为代码完成的提示。 下面是一篇很好的博客文章,它帮助了我:
/**
List Title:
- Item 1
- Item 2
- Item 3
*/