はじめてのKotlin入門
第5回 プログラムに注釈を入れる

未来の自分のために!

こんにちは!

最近、Oculus GoでVRプラネタリウムを見ることにハマっています。

何がすごいって、好きな年月日時刻と時間の進む速度まで指定して夜空を見ることができるのです!

いままさにこの時間に見える夜空をVRで見ながら、「いや、外に出ろよ」と心の中でツッコミを入れているあらたまです。

だって、寒いじゃん。

さて、今日は「はじめてのKotlin入門」の第5回です。

おさらい

前回では 関数への値の引き渡しかた、

そしてその引き渡される値のことを「引数」と呼ぶ、ということをお話しましたね。

    /**
    * You can edit, run, and share this code. 
    * play.kotlinlang.org 
    */

    fun main() {
        println("Hello, world!!!")
    }

今回も引き続き 「Kotlin Playground」の サンプルプログラムを見ながら、「コメント」というものについてお話したいと思います。

「コメント」ってなんだろう?

コメント(Comment)という英単語、日本語に訳そうとすると意外とぴったり当てはまる単語が日本語にはないのですよね。 あえて当てはめるなら「言い添える」でしょうか。

ちなみに辞書で「Comment」を検索すると、「批評」「解説」「注釈」などの意味が出てきます。
これらに共通するところは何かに対して言葉を横からたしたり、付けたりすることですよね。

プログラミングにおける「コメント」

さて、そのような意味の「コメント」ですが、プログラミングにおいても「コメント」をつけることができます。

この「コメント」はあくまで言い添えた(書き添えた)言葉でしかなく、 プログラムの動作には影響を与えません。

サンプルプログラムの場合の「コメント」はこの部分です。

    /**
    * You can edit, run, and share this code. 
    * play.kotlinlang.org 
    */

    fun main() {
        println("Hello, world!!!")
    }

ちなみにこのコメントは英語で「このプログラムを編集したり、実行したり、誰かと共有したりすることができるよ」 と書いてあります。Kotlin Playgroundの中の人からのあなたへのメッセージですね。

まさに、プログラムにあなたへのメッセージを書き添えているわけです。

コメントの書き方

コメントの書き方には2種類あります。
/* ~ */

//
です。

ひとつ目 /* ~ */

「/*」がプログラム中に出てくると、次に「*/」が出てくるまでをコメントとみなします。 複数行にまたがってコメントを書くことが可能です。サンプルプログラムで使われているのもこの書き方ですね。

    /**
    * You can edit, run, and share this code. 
    * play.kotlinlang.org 
    */

    /* ここから、、
    ここも
    ここも
    ここも
    ここだってコメント */

    fun main() {
        println("Hello, world!!!")
    }

ふたつ目 //

「//」がプログラム中に出てくると、そこからその行の終わりまでをコメントとみなします。

    /**
    * You can edit, run, and share this code. 
    * play.kotlinlang.org 
    */

    /* ここから、、
    ここも
    ここも
    ここも
    ここだってコメント */

    // この行はコメント
    fun main() {
        println("Hello, world!!!") // こっから後ろはコメント
    }

動作を確認してみよう

それではプログラムの動作をみておきましょう。

ブラウザで「Kotlin Playground」を開いて、 コメントを書き足してみます。

「▶」をクリックします。

「Hello, World!!!」と表示されました。 コメントがプログラムの動作に影響を与えていないことがわかりますね。

で、何に使うの?

さてこの「コメント」。プログラムの動作に影響を与えないならいったい何のために使うの?って感じですよね。

使う理由はシンプル「人間がプログラムを見たときにわかりやすくするため」です。

色々なケースが考えられますが、例えばあなたがスマホアプリを開発したとします。

で、一か月ぐらいしてから面白い追加機能を思いついたのでアップデートをしようと思った。

一か月ぶりに自分の書いたプログラムを見るわけです。

はい、だいたい、中身を忘れてます。

なんでこんな風に書いたんだっけ?ここは何に使ってるんだっけ?そんな感じです。

もしも最初に開発したときに、
「ここは〇〇だったので、△△を使うことにした」とか
「ここは○○の計算をしている」とか
あらかじめコメントを書き残していれば、1カ月後の未来の自分を助けてあげることができるわけですね。

もしもプロのシステムエンジニアになって、チームで何かを開発するときにもこれは必須スキルです。

ですので、プログラミングをするときは日ごろからコメントは書く癖を付けておくのをお勧めしますよ。

今回はここまでです!

次回はKotlinにおける「行」というものについてご説明したいと思います。

次回へ続く。

>> 続きの記事
【はじめてのKotlin入門】第6回 Kotlinの行を知ろう