【Swift】わかりやすいプログラムを目指す！コメントの使い方

こんにちは、コン（@pippi_kon）です。

この記事は、主にプログラミング言語「Swift」の初心者向けに、iPhoneアプリを作るための情報を記載しています。

今回は、プログラムをわかりやすくする「コメント」についてご紹介します。

プログラムの説明文

コメントとは、プログラム内に書けるメモや説明文のことです。

コメントはプログラム実行時に無視されるため処理に影響を与えることはありません。

ですが、コメントはとても重要です。

プログラムが長くなってくると、どこでどのような処理が行われているかがわかりにくくなってきます。

1行ずつ順番に解読していくのは疲れますし非効率です。

そんな時に活躍するのがコメント。

コメントで「ここはこんな処理をしてるよ」と説明文をつけておけばプログラムを読みやすくなります。

チーム開発では必須

プログラムを他人と共有する時にも非常に有効です。

人が書いたプログラムって基本的に読みにくいですよね。

なぜなら、自分のコーディングスタイルと違うから。

なので、コメントを書いて「ここではこんなことをしているよ」という処理の内容を書いてあげると親切です。

さらに、既存のプログラムコードを使用しないようにする（退避）する場合にも便利です。

プログラムコードで不要になった部分があるけど、あとでまた復活させるかもしれないので消したくない…

そんな時はプログラムをコメント化して（コメントアウトという）実行されないようにしましょう。

コメントは諸刃の剣

コメントはとても便利なものだと言ってきましたが、実は諸刃の剣でもあります。

なぜならコメントに間違いが書いてあるおそれがあるからです。

単に間違っているパターンもあれば、プログラム改修によって処理が変わったパターンもあります。

コメントに書いてあることだけを信じてプログラムを作成するとバグを作り込んでしまうおそれがあります。

プログラム追加・修正する際は、あくまでコメントは参考程度にし、プログラムの前後関係は必ず確認しましょう。

書式

コメントは2種類の記述方法があります。

書式1

// 1行コメント

書式2

/* 複数行コメント */

使い方

以下の2パターンの使い方についてご紹介します。

1行コメント
複数行コメント

なお、いずれのパターンもSingle View Appプロジェクトを作成した直後の状態を前提としています。

【Swift】基本的なプロジェクト（Single View App）の作成方法iPhoneアプリを作成する際にまず行う「基本的なプロジェクトの作成方法」についてご紹介します。...

（１）1行コメント

1行コメントはその名の通り1行だけコメント文を記述できるものです。

「2つの半角スラッシュ（//）からその行の終わりまで」がコメントになります。

サンプルプログラム

let name = "KON"    // 名前
let age = 30        // 年齢
// print("名前は", name)
// print("年齢は", age)
print("私は", name, "です。年齢は", age, "です。")

実行結果

このようにConsoleに表示されます。

定数のnameとageにコメントをつけましたが処理に影響はありません。

また、コメント化されたprint文は実行されません。

全プログラムコード

import UIKit

class ViewController: UIViewController {

    override func viewDidLoad() {
        super.viewDidLoad()
        // Do any additional setup after loading the view, typically from a nib.
        
        let name = "KON"    // 名前
        let age = 30        // 年齢
        // print("名前は", name)
        // print("年齢は", age)
        print("私は", name, "です。年齢は", age, "です。")
    }

    override func didReceiveMemoryWarning() {
        super.didReceiveMemoryWarning()
        // Dispose of any resources that can be recreated.
    }


}

（２）複数行コメント

複数行コメントはその名の通り複数行のコメント文を記述できるものです。

「/*から*/まで」がコメントになります。

「/」は半角スラッシュ、「*」は半角アスタリスクです。

なお、複数行コメントで1行だけコメントすることもできます。

サンプルプログラム

let name = "KON"    /* 名前 */
let age = 30        /* 年齢 */
/*
print("名前は", name)
print("年齢は", age)
*/
print("私は", name, "です。年齢は", age, "です。")

実行結果

このようにConsoleに表示されます。

全プログラムコード

import UIKit

class ViewController: UIViewController {

    override func viewDidLoad() {
        super.viewDidLoad()
        // Do any additional setup after loading the view, typically from a nib.
        
        let name = "KON"    /* 名前 */
        let age = 30        /* 年齢 */
        /*
        print("名前は", name)
        print("年齢は", age)
        */
        print("私は", name, "です。年齢は", age, "です。")
    }

    override func didReceiveMemoryWarning() {
        super.didReceiveMemoryWarning()
        // Dispose of any resources that can be recreated.
    }


}