有关覆盖方法的Swift文档注释？

Question

我想将标记文档添加到由于类符合UICollectionViewDataSource而实现的Swift函数。例如：

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

显然我的注释被忽略，生成的文档仍然是从合同定义（或其他一些默认位置）继承的文档，对于快速帮助（在Xcode 7.1.1中），包括以下文本：

  

返回节中的行数。

我如何＆＃34;覆盖＆＃34;这样的默认文档可以调出我的实现中的变化吗？

Answer 1

似乎在重写函数中需要提供多行注释（似乎/ * * /不起作用，需要/ ** * /）而不是多行单行。有趣的是，多行单行注释适用于未覆盖的函数。更有趣的是，当你输入方法时，你会得到正确的，被覆盖的注释，但是一旦你输入它并单击alt，快速帮助就会忽略它。

示例：

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