【Xcode】自作メソッドにドキュメントを追加する方法

2022.01.22

誰かにコードをお渡しする場合、メソッドにドキュメントがあると親切ですよね。ということで、今回はメソッドにドキュメントを追加する方法を紹介します。

環境

  • Xcode 13.2.1

ドキュメント

今回のドキュメントとは、このようにメソッドの上に記述してあるものになります。

/// コースリストを作成します
/// - Parameters:
///   - soup: スープ料理
///   - fish: 魚料理
///   - meat: 肉料理
///   - sweets: スイーツ
///   - cheese: チーズ
///   - dessert: デザート
/// - Returns: コースリストの文字列
func make6Course(soup: String,
                 fish: String,
                 meat: String,
                 sweets: String,
                 cheese: String,
                 dessert: String) -> String {

    let courseList = "- \(soup)\n- \(fish)\n- \(meat)\n- \(sweets)\n- \(cheese)\n- \(dessert)"
    return courseList
}

このメソッドをXcode上でoption + クリックをしてみてみましょう。

このメソッドを使う日が来るかは分かりませんが、ドキュメントがあることでどんなメソッドか分かりやすくなりました。

ドキュメントを追加する方法

対象のメソッドが記述されている行が選択されている状態で、

Xcode > Editor > Structure > Add Documentation を押します。

また、ショートカットキーの option + command + / を押すことで自動で追加されます。

Add Documentationをするとこのようになります。

おわりに

今回はドキュメントを簡単に追加する方法を学びました。

せっかくメソッドも作ったので是非召し上がりください。

let course = make6Course(soup: "コーンスープ",
                         fish: "しめ鯖",
                         meat: "ミートボール3個",
                         sweets: "かき氷",
                         cheese: "三角のチーズ",
                         dessert: "スイカ")
print(course)