代码之家  ›  专栏  ›  技术社区  ›  bemeyer

XCODE中未显示的类文档

  •  0
  • bemeyer  · 技术社区  · 6 年前

    我正在编写一个需要很多文档的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 {
    }
    

    我只得到: enter image description here

    如果将文档重新排序为:

    /// 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 {
    }
    

    我至少看到了: enter image description here

    但我的书面文件什么都没有。方法或字段文档似乎工作正常。

    如何正确编写类文档?有什么事要做吗? @IBDesignables 其他的课程看起来还不错吧?

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

    Jazzy确实正确地导出了所有内容。

    1 回复  |  直到 6 年前
        1
  •  1
  •   Herr der Töne    6 年前

    删除注释第一行中的严重重音(`)。Xcode似乎在链接中不支持这个功能!如果删除它们,将提供快速帮助。

    而不是

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

    使用

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