Swift 3错误:"另请参见"标注未显示

Tap*_*Pal 25 code-documentation ios swift3 xcode8

我刚刚将我的项目迁移到swift 3中,发现"看到"的快速帮助标注没有显示出来.在以前版本的swift中,一切都完美无缺.以下是我的代码

/**
 Adds a See also callout to the Quick Help for a symbol using the See Also delimiter. Multiple See also callouts appear in the description section in the same order as they do in the markup..

 - author: Tapas Pal

 - remark: Use the callout to add references to other information.

 - seealso: [The Swift Standard Library Reference](https://developer.apple.com/library/prerelease/ios//documentation/General/Reference/SwiftStandardLibraryReference/index.html)

 */
class SeeAlsoMarkup: NSObject {
    static func doSomething() {}
}
Run Code Online (Sandbox Code Playgroud)

输出就像

在此输入图像描述

Apple是否通过此标记更改了任何内容?但是它的文档仍然显示相同.

Aja*_*hra 6

将 seealso 替换为 # 参考

在此处输入图片说明

  • 使用#Reference,Xcode不显示包含的链接 (2认同)

Lou*_*Tur 5

(XCode 11,Swift 5)

为了澄清这个问题,XCode 似乎承认文档注释中的降价。如果你有类似的东西:

/// # Reference 
/// [Link to Reference](https://www.google.com)
Run Code Online (Sandbox Code Playgroud)

它被记录为:

Reference markdown 的屏幕截图

我不知道这是否以同样的方式与文档关键字挂钩@seealso,因为#markdown 标签只是指标题样式。为了证明这一点,您可以使用#标签向文档中添加任意部分:

///  # Reference
///  [Link to Reference](https://www.google.com)
///  # Section
///  This is a new section of documentation
///  # Remark
///  New remark
Run Code Online (Sandbox Code Playgroud)

记录为:

在此处输入图片说明