【问题标题】:Adding Custom Documentation to Overridden Functions将自定义文档添加到覆盖的函数
【发布时间】:2017-01-12 11:28:56
【问题描述】:

我一直在努力养成将 Apple 的 Markdown 文档变体添加到我编写的所有函数的习惯。但是,我不确定如何添加此文档以显示在 quicklook 窗口中。是否可以替换或最好附加到现有文档?

例如,在这张图片中,quicklook 窗口显示的是现有的 Markdown 文档,而不是我上面写的文档。

【问题讨论】:

    标签: swift xcode documentation comments markdown


    【解决方案1】:

    可悲的是,似乎没有办法做到这一点。

    您可以使用自己的文档定义一个新函数,该函数调用被覆盖的函数,仅此而已。

    示例:

    /**
     custom documentation
     */
    func viewDidLoadOverridden() {
        viewDidLoad()
    }
    

    结果:

    【讨论】:

    • 太糟糕了,一年多了,仍然没有好的方法。我认为你的想法很有趣,但我喜欢的解决方法有点太多(想象一下,试图让一个开发团队同意编写这样的函数作为文档的解决方法)。
    猜你喜欢
    • 2016-11-05
    • 1970-01-01
    • 1970-01-01
    • 1970-01-01
    • 2021-12-19
    • 2013-05-15
    • 2015-09-23
    • 1970-01-01
    • 2010-10-31
    相关资源
    最近更新 更多