SONICMOOV Googleページ

【iPhoneアプリ開発入門】Swift 文書化コメントで自作関数の使い方を分かりやすくする方法

【iPhoneアプリ開発入門】Swift 文書化コメントで自作関数の使い方を分かりやすくする方法

  • このエントリーをはてなブックマークに追加

最近ポケモンGOにハマっているトクです。島根には殆どポケストップが無くて、常にモンスターボール不足な状況が続いていますが、それなりに楽しんでいます…。

さて今回は、「文書化コメント」について説明したいと思います。

文書化コメントとは、関数やメソッドの使い方を記述したコメントのことで、関数を使用する時に説明が見えるようにするためのものです。

クラスの使い方 等で print を記述されたかと思いますが、option キーを押しながらマウスカーソルを関数へ持っていくと「 ? 」マークが表示されます。この状態でクリックしたら下のようなバルーンが表示され、引数などを見ることができます。文書化コメントを使用することにより、自分で作成した関数にも同じように表示させることが出来るようになります。

Swiftの文書化コメント

使い方

/** から始まるコメント、または /// で始まる行末までのコメントが文書化コメントとして扱われます。

/**
 コメント
 */
/// コメント

一般的なもの

説明

関数の説明を記述できます。

/**
 説明
 */
func comment0() {
}

引数

引数に関する情報を記述でき、書き方には二通りあります。

/**
 - parameter パラメータ名1: 詳細
 - parameter パラメータ名2: 詳細
 */
func comment1(param1: Int, param2: Int) {
}
/**
 - parameters:
    - パラメータ名1: 詳細
    - パラメータ名2: 詳細
 */
func comment1(param1: Int, param2: Int) {
}

戻り値

戻り値について記述できます。

/**
 - returns: 戻り値詳細
 */
func comment2() -> Int {
    return 0
}

エラー

エラーが投げられる場合の説明を記述できます。

/**
 - throws: エラーがthrowされる場合の説明
 */
func comment3() {
}

その他

段落

空白改行で区切ります。

/**
 段落1
 
 段落2
 
 段落3
 */
func comment4() {
}

ソースコードを引用

他の段落より空白4つ分右にインデント又は、バッククォート3つで挟んだ段落

/**
 説明
 
     print("hello")
 
 */
func comment5() {
}
/**
説明
 ```
 print("hello")
 ```
 */
func comment5() {
}

実例

文書化コメントを使用した例

enum BallType {
    case MonsterBall
    case SuperBall
    case HyperBall
    case MasterBall
}

/**
 指定したIDのボケモンをゲットする
 
 - parameters:
    - id: ボケモンのID
    - ballType: モンスターボールのタイプ
 
 - returns: ゲットできたかどうか
 */
func bokemonGet(id: Int, ballType: BallType) -> Bool {
    return false
}

まとめ

文書化コメントを使用することにより、関数の使い方が分かりやすくなったかと思います。他にも便利な機能がありますので、調べて使用してみてください。

参考
Markup Formatting Reference

  • このエントリーをはてなブックマークに追加

記事作成者の紹介

トク(フロントエンドエンジニア)

ゲームが好きなプログラマーです。好きな言葉は「自動化」。

フロントエンドエンジニア募集中!

×

SNSでも情報配信中!ぜひご登録ください。

×

SNSでも
情報配信中!
SONICMOOV Facebookページ SONICMOOV Twitter SONICMOOV Googleページ
フロントエンドエンジニア募集中!

新着の記事

mautic is open source marketing automation