如何在文档Xcode中添加链接/引用到另一个方法?

时间:2016-07-12 06:52:44

标签: ios swift xcode documentation

我在课堂上为我的方法添加了一些描述。这就是我实现这个目标的方式:

enter image description here

单击时看起来像这样......

enter image description here

如何使带下划线的方法可以点击?我希望它被引用,以便当用户点击它时,它们被定向到特定的网页以获取文档。

甚至可能吗? 在此先感谢,任何帮助将不胜感激

3 个答案:

答案 0 :(得分:10)

您可以链接到另一种方法,方法是使用/// - Tag:标记Tag并用x-source-tag://[Tag]引用它,如下所示:

/// - Tag: someMethod
func someMethod() {
   ...
}

/// Make sure to call [someMethod](x-source-tag://someMethod) at some point when overriding.
func otherMethod() {
   ...
}

单击“快速帮助”弹出窗口中的someMethod链接将带您进入该方法,并以黄色将其高亮显示。

答案 1 :(得分:2)

This link解决了我的问题

特别是,我就是这样做的

enter image description here

感谢Oleg的链接

答案 2 :(得分:0)

使用此

 /**
     *  <#Description#>
     *
     *  @link UILabel <#UILabel description#>
     *
     *  @return <#return value description#>
     */

或者您可以尝试使用vvDocumenter发表评论