在快速帮助文档注释中添加到Swift类的链接？ [英] Add links to Swift classes in the quick help 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() {}
}

我想从Bar在Xcode中的快速帮助中创建到Foo或Foo的快速帮助的链接。可能吗？如果是这样，怎么办？

I want to create a link to Foo or Foo's quick help from Bar's quick help in Xcode. Is it even possible? If so, how?

链接的 [name]（target）语法不适合据我查看 Apple的文档和更多Apple的文档。

The [name](target) syntax for links isn't up to snuff as far as I can tell by looking at Apple's docs and more Apple's docs.

推荐答案

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

I just stumbled upon this. Apparently, if the text you enclose in backticks happens to be a class, it will be rendered as a hyperlink to the class.

这篇关于在快速帮助文档注释中添加到Swift类的链接？的文章就介绍到这了，希望我们推荐的答案对大家有所帮助，也希望大家多多支持IT屋！