类文档未显示在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 {
}

我至少看到：

但是我的书面文档中没有。方法或现场文档似乎正常工作。

如何正确编写课程文档？这和其他课程有关吗？@IBDesignables似乎还不错？

我已经在Xcode 9.x.x和Xcode 10.0 beta中进行了尝试。

_{Jazzy确实可以正确导出所有内容。}

Answer 1

删除注释第一行中的Grave重音（`）。 Xcode在链接中似乎不支持该功能！如果删除它们，则会显示您的快速帮助。

代替

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

使用

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