Class 文档未显示在 Xcode 中

Question

我正在编写一个需要大量文档的 UIKit 库。

我已将文档作为常规添加到每个库中，但它没有显示在快速帮助中。

示例：

import UIKit

/// An extension of Apples [`UILabel`](https://developer.apple.com/documentation/uikit/uilabel).
///
/// The whole label is configurable within the storyboard builder using the`@IBInspectable`.
///
///     let myLabel = MyLabel()
///
@IBDesignable
open class MyLabel: UILabel {
}

我得到的是：

如果将文档重新排序为：

/// An extension of Apples [`UILabel`](https://developer.apple.com/documentation/uikit/uilabel).
///
/// The whole label is configurable within the storyboard builder using the`@IBInspectable`.
///
///     let myLabel = MyLabel()
///

import UIKit

@IBDesignable
open class MyLabel: UILabel {
}

或

导入 UIKit

@IBDesignable
/// An extension of Apples [`UILabel`](https://developer.apple.com/documentation/uikit/uilabel).
///
/// The whole label is configurable within the storyboard builder using the`@IBInspectable`.
///
///     let myLabel = MyLabel()
///
open class MyLabel: UILabel {
}

至少我看到了：

但我的书面文档中没有任何内容。方法或字段文档似乎工作正常。

如何正确编写 class 文档？这与 @IBDesignables 其他 class 似乎工作正常有关吗？

我在 Xcode 9.x.x 和 Xcode 10.0 beta 中试过了。

_{Jazzy 会正确导出所有内容。}

Answer 1

删除评论第一行中的重音符号 (`)。 Xcode 似乎不支持在链接中使用！如果您删除它们，将呈现您的快速帮助。

而不是

/// An extension of Apples [`UILabel`](https://...)

使用

/// An extension of Apples [UILabel](https://...)

Class 文档未显示在 Xcode 中

Class documentation not showing up in Xcode

swift

xcode

markup