ios - 覆盖方法的 Swift 文档注释？

Question

我想将标记文档添加到一个 Swift 函数中，该函数是由于一个类符合 UICollectionViewDataSource 而实现的。例如:

///
/// - returns: Why is this documentation ignored?
///
override func collectionView(collectionView: UICollectionView, numberOfItemsInSection section: Int) -> Int {
    return 2
}

显然我的评论被忽略了，生成的文档仍然是从契约(Contract)定义(或其他一些默认位置)继承的文档，因为快速帮助(在 Xcode 7.1.1 中)包含以下文本:

Returns The number of rows in section.

我如何“覆盖”这样的默认文档以在我的实现中调用更改？

Answer 1

似乎在重写的函数中，您需要提供多行注释(似乎/* */不起作用，您需要/** */)而不是多行注释。有趣的是，多单行注释对于未被重写的函数工作得很好。更有趣的是，当您输入方法时，您会得到正确的、被覆盖的注释，但是一旦您将其关闭并单击 alt，Quick Help 就会忽略它。

示例:

/**
    Works fine as you are typing.
*/
override func viewDidAppear() {
    print("test")
}