如何在 Xcode 文档中添加指向另一个方法的链接或引用?

Question

如何在 Xcode 文档中添加指向另一个方法的链接或引用?

iosswiftxcodedocumentation

43

我正在给我的类中的方法添加一些描述。这是我实现的方式:

点击后它看起来像这样...

如何使下划线的方法可点击？我想引用它，以便当用户单击它时，它们将被指向特定的文档网页。

这是否可能？提前感谢，任何帮助都将不胜感激。

- Akshansh Thakur

可能是Swift是否有文档注释或工具？的重复问题。 - Oleg Gordiichuk

尝试使用此答案 https://dev59.com/G2Ag5IYBdhLWcg3wBXKs - Oleg Gordiichuk

@OlegGordiichuk 非常感谢！这解决了我的问题。 - Akshansh Thakur

3个回答

-2

这个链接解决了我的问题

具体来说，我是这样做的

感谢 Oleg 提供的链接

- Akshansh Thakur

3

根据图片显示，我使用https://www.myLink，但它对我不起作用。即使它能起作用，我也会感到非常惊讶，但我还是进行了检查。我正在使用Xcode 9.4。 - Michael

1

我真的很努力地想找到解决这个问题的方法。不幸的是，即使在Xcode 10中，JavaDoc风格的链接仍然不受支持。很遗憾... - Stan Mots

-3

使用这个

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

或者你可以尝试使用vvDocumenter来添加注释

- Vibha Singh

2

我认为那行不通。我刚试了这个语法：<#ClassName methodName#>我认为这是自动完成建议占位符的语法。 - Apoorv Khatreja

网页内容由stack overflow 提供, 点击上面的

可以查看英文原文，
原文链接

- Clay Ellis · Accepted Answer

Xcode 13 的新功能

使用 Xcode 中的新 DocC 工具，你现在可以使用双反引号来引用其他方法。

如果你所引用的类型、属性或方法与你正在记录的内容不是“同级”的，你可以通过限定引用来引用它。

struct House {
    /// The rooms in the house.
    var rooms: [Room]

    /// The maximum size of the household.
    ///
    /// This is calculated by summing the ``Room/occupancyLimit`` of this 
    /// house's ``rooms``.
    var maximumHouseholdSize: ...
}

struct Room {
    /// The maximum number of occupants allowed in the room.
    var occupancyLimit: ...
}

这里，对于House.maximumHouseholdSize的文档注释使用以下方式引用House.rooms：

``rooms``

因为房间是最大家庭人数的同级元素。

它还使用Room.occupancyLimit引用：

``Room/occupancyLimit``

由于occupancyLimit不是嵌套在同一种类型中，而是在Room类型下。

Xcode 13之前

您可以通过使用 ///-Tag：对其进行标记，并使用x-source-tag://[Tag]方案引用 Tag 来链接到另一种方法，如下所示：

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

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

点击快速帮助弹出框中的 someMethod 链接，将带您进入该方法并以黄色闪烁方式突出显示它。