将自定义文档添加到重写的函数

时间:2016-09-05 06:06:52

标签: swift xcode documentation comments markdown

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

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

Here's an example of what I'm referring to

1 个答案:

答案 0 :(得分:1)

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

您可以使用自己的文档定义一个新函数,该文档调用被覆盖的函数,而不是其他任何内容。

示例:

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

<强>结果:

custom documentation for "overridden" function