Swift簡単入門〜コメント編｜XcodeのPlaygroundで楽しい学びの世界

無料でプログラミングを学ぶ

子供から大人まで楽しんで学ぶSwift簡単入門！！！

今回は、コメントの書き方について学習したいと思います。

コメントは、プログラムを読みやすくしたり、どんな処理をしているのかなどの記録をしておくためにとても大事な内容となります。

また、コメントをすぐに入れれるように、後半では、ショートカットも紹介したいと思います。

もし、検索からこちらに飛んできた方は、初回の「Swift簡単入門〜準備編｜XcodeのPlaygroundで楽しい学びの世界」からスタートしてみてください。

SwiftでiPhoneゲームアプリを作ろう！

Swiftのコメント記述方法
Xcodeで素早くコメント化を行うショートカット
まとめ

Swiftのコメント記述方法

Swiftでは、３種類のコメント記述方法があります。

１行毎のコメント

簡単なコメントやプログラムのこの行だけ実行したくないという場合に使われます。

// 基本形
    // コメントの内容

// デバッグ用の出力文をコメントアウトして実行しないようにする
    // print(debug)  <- この行はコメントアウトしたので、実行されません

ブロック(複数行)でのコメント

複数行のコメントや複数行のプログラムを実行したくないという場合に使われます。

// 基本形
    /* コメント　*/

// 工夫した使い方
    /************************
    / 関数名                  /
    / 使い方                  /
    / バージョン               /
     ************************/

ドキュメントコメントとそのショートカット

Swiftでは、ドキュメントコメントにマークアップ言語を使用することができます。

それを使って、関数などのコメントを半自動で作成できます。

// 下記のような関数を書いたとします
func div(bunshi: Int,bunbo: Int) -> Int {
    return bunshi / bunbo
}

上記コードで入力した関数部分にカーソルを合わせて「option + command + /」を押下します。

すると下記のような状態になります。
下記の「///」部分が自動的に挿入された部分です

/// <#Description#>
///
/// - Parameters:
///   - bunshi: <#bunshi description#>
///   - bunbo: <#bunbo description#>
/// - Returns: <#return value description#>
func div(bunshi: Int,bunbo: Int) -> Int {
    return bunshi / bunbo
}

その後、<#~~#>部分に関数の説明、引数、戻り値等の説明を記入しドキュメントコメントを仕上げます。

/// 割り算を行う関数
///
/// - Parameters:
///   - bunshi: 分子
///   - bunbo: 分母
/// - Returns: 割り算の結果を整数で返す
func div(bunshi: Int,bunbo: Int) -> Int {
    return bunshi / bunbo
}

Xcodeで素早くコメント化を行うショートカット

Xcodeを使用している際に素早くコメントアウトするためのショートカットを紹介したいと思います。

command + /
カーソルのある行もしくは選択されている行がコメントアウトされます。
既にコメントアウトされた行の場合は、コメント解除されます。
複数行を一度にコメントアウトしても１行毎のコメント「//」となります。
ブロックでのコメントのショートカットはありません
もし、ご存知の方があれば、コメントをお願いします。

まとめ

今回は３種類のコメントについて書きました。

１行コメント
ブロックコメント
ドキュメントコメント

プログラムは、コメントの有無で可読性がかなり違いますので、できるだけ書くように心がけましょう。

ただし、書き過ぎは、逆に読みづらくなりますので、簡潔に書くように心がけましょう。