如何在文档 Xcode 中添加对另一种方法的链接/引用？

Question

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

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

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

甚至有可能吗？ 提前致谢，任何帮助将不胜感激

Answer 1

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``

因为rooms是maximumHouseholdSize的兄弟。

它还引用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链接将带您到该方法并以黄色闪光突出显示它。

Answer 2

这个链接解决了我的问题

特别是，我就是这样做的

感谢奥列格的链接

Answer 3

使用这个

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

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