如何将 link/reference 添加到文档 Xcode 中的另一个方法？

Question

我正在 class 中为我的方法添加一些描述。我就是这样实现的：

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

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

这可能吗？ 提前致谢，我们将不胜感激

Answer 1

使用这个

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

或者你可以试试 vvDocumenter 来评论

Answer 2

This link 解决了我的问题

特别是，这就是我的处理方式

感谢 Oleg link

Answer 3

新 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

您可以 link 通过使用 /// - Tag: 标记它并使用 x-source-tag://[Tag] 方案通过 Tag 引用它来 link 到另一个方法，如下所示：

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

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

单击“快速帮助”弹出窗口中的 someMethod link 将转到该方法并以黄色快速突出显示它。