如何在Swift的Quick Help注释中添加换行以实现多行描述

当前写法的显示效果 #

你现在用的这种每一行都带///的写法，在Xcode的Quick Help里不会自动换行——所有文本会被合并成一段连续内容，最终显示成：

Description of class Foo - line 1 line 2 line 3 line 4

相当于把所有行的内容直接拼接在一起，没有任何换行或分段。

实现多行显示的两种方法 #

方法1：用空的///行分隔段落（推荐）

如果希望在Quick Help里分成不同的段落（视觉上的换行分段），可以在需要换行的地方插入一行单独的///：

/// Description of class Foo - line 1
/// 
/// line 2
/// line 3
/// 
/// line 4
class Foo { }

这样在Quick Help里，空行分隔的部分会变成独立段落，自动换行并留出段落间距。

方法2：用<br>标签强制单行换行

如果想在同一个段落里强制换行、保持内容紧凑，可以使用HTML的<br>标签：

/// Description of class Foo - line 1<br>
/// line 2<br>
/// line 3<br>
/// line 4
class Foo { }

这种写法会让每一行文本在Quick Help里严格按照你标注的位置换行，所有内容属于同一个段落。

额外小提示 #

Xcode的Quick Help支持部分HTML格式，除了<br>，你还可以用<b>、<i>这些标签来加粗或斜体文本，让注释更清晰~

内容的提问来源于stack exchange，提问作者matchifang