📝

Swift Documentationで他メソッドへの参照リンクを埋め込む

2023/01/05に公開約400字

SwiftではDocumentationにリンクを埋め込み、⌘+クリックでリンク先にジャンプすることができますが、他メソッドやプロパティへの参照リンクも埋め込めることは知らなかったのでメモしておく。

/// `https://zenn.dev/`を参照してください

(※)バッククォーテーションはなくても問題ない。

以下のように、バッククォーテーション2つで囲めば簡単にできる。

/// Implement the ``doSomething()`` requirement method.

なお、同名のメソッドが複数ある場合はスラッシュでスコープを指定すれば良い。
ドットではないので注意。

struct A {
    func doSomething() {}
}

struct B {
    /// See ``A/doSomething()`` method
    func doSomething() {}
}

ドキュメンテーションでも補完が表示されるのは便利だった。

Discussion

ログインするとコメントできます