在快速帮助文档注释中添加指向Swift类的链接?

时间:2017-04-26 13:11:40

标签: swift xcode documentation comments

假设我有两个班级:

/**
  This class should be used together with [Foo]( ??? ).
*/
class Bar {
    func doNothing() {}
}

/**
  Description of what Foo does goes here.
*/
class Foo {
    func doNothing() {}
}

我想在Xcode的Bar快速帮助中创建一个指向Foo或Foo快速帮助的链接。它甚至可能吗?如果是这样,怎么样?

通过查看Apple's docsmore Apple's docs,链接的[name](target)语法无法通知。

1 个答案:

答案 0 :(得分:1)

我偶然发现了这一点。显然,如果您在反引号中包含的文本恰好是一个类,则它将呈现为该类的超链接。