Ios 覆盖方法的Swift文档注释?
我想将标记文档添加到Swift函数中,该函数的实现是因为类符合Ios 覆盖方法的Swift文档注释?,ios,swift,documentation,swift2,ios9,Ios,Swift,Documentation,Swift2,Ios9,我想将标记文档添加到Swift函数中,该函数的实现是因为类符合UICollectionViewDataSource。例如: /// /// - returns: Why is this documentation ignored? /// override func collectionView(collectionView: UICollectionView, numberOfItemsInSection section: Int) -> Int { return 2 } 显然
UICollectionViewDataSource
。例如:
///
/// - returns: Why is this documentation ignored?
///
override func collectionView(collectionView: UICollectionView, numberOfItemsInSection section: Int) -> Int {
return 2
}
显然,我的注释被忽略,生成的文档仍然是从合同定义(或其他一些默认位置)继承的文档,快速帮助(在Xcode 7.1.1中)包括以下文本:
返回节中的行数
如何“覆盖”这样一个默认文档来调用实现中的更改?似乎在被覆盖的函数中,您需要给出多行注释(似乎/***/不起作用,您需要/***/),而不是多行注释。有趣的是,多行单行注释适用于未重写的函数。更有趣的是,当您键入该方法时,您会得到正确的、被覆盖的注释,但Quick Help会在您键入并单击alt后忽略它 示例:
/**
Works fine as you are typing.
*/
override func viewDidAppear() {
print("test")
}
如果/**……**/之后是单行注释//在方法签名之前,它也不起作用。也许更多的是一个bug而不是一个特性。