Kotlinのコメントの書き方ガイド！1行・複数行コメントの基本と使い分け
生徒
「Kotlinでコメントってどうやって書くんですか？プログラムの中に説明を入れたいんですけど…」
先生
「いい質問ですね。Kotlinでは、コードの中に説明やメモを残すためにコメントを使います。コメントはプログラムの動作には影響しません。」
生徒
「なるほど。具体的にはどうやって書くんですか？」
先生
「それでは、Kotlinのコメントの基本的な書き方を見ていきましょう！」
1. コメントとは？
コメントとは、プログラムの中に書く人間向けの説明です。あとで自分が読み返すときや、同僚に意図を伝えるときに役立ちます。Kotlinではコメントはコンピューターに無視されるため、処理や結果に一切影響しません。動作確認のメモや「なぜこの書き方にしたのか」を残す場所と考えると分かりやすいでしょう。
コメントがあっても出力は変わらないことを確認してみます。
fun main() {
// あいさつ文を表示する（ここは説明なので実行されない）
println("Hello, Kotlin!")
println("コメントは実行結果に影響しません") // 行の途中に書いてもOK
}
Hello, Kotlin!
コメントは実行結果に影響しません
上の//以降はすべて説明文です。あくまで「読み手のための情報」であり、プログラムの動作はprintlnだけが担当します。
このようにコメントは、コードの意図・前提・注意点を短く残すための基本機能です。読みやすいコードづくりの第一歩として、必要な場所に簡潔に添える習慣をつけていきましょう。
2. 1行コメントの書き方
1行コメントは、//から始めて、その行の終わりまでがコメントになります。主に短い説明やメモを書くときに使います。
fun main() {
// これは1行コメントです
println("Hello, Kotlin!") // 出力するメッセージ
}
3. 複数行コメントの書き方
複数行コメントは、/*で始まり、*/で終わります。複数行にわたる説明や、大きなブロックのコードを一時的に無効にする場合に使います。
fun main() {
/*
これは複数行コメントです。
複数行にわたって説明を書くことができます。
*/
println("Hello, Kotlin!")
}
4. コメントの使い分け
1行コメントと複数行コメントは、用途に応じて使い分けます。
- 1行コメント: 短い説明やメモに適しています。
- 複数行コメント: 長い説明や複数行にわたるコメントに適しています。
5. コメントのネスト（入れ子）
Kotlinでは、複数行コメントの中にさらに複数行コメントを入れることができます。これを「ネスト」と呼びます。
fun main() {
/*
これは外側のコメントです。
/*
これは内側のコメントです。
*/
*/
println("Hello, Kotlin!")
}
6. コメントの活用例
コメントは、コードの意図や動作を説明するために活用します。以下は、コメントを使った例です。
fun main() {
// ユーザーの名前を表示する
val name = "Kotlin"
println("Hello, $name!")
}
このように、コメントを使うことで、コードの読み手が理解しやすくなります。
まとめ
Kotlinでのコメントの書き方について学ぶことで、プログラムの可読性を高め、将来の保守やチーム開発において非常に役立つ知識を身につけることができました。//を使った1行コメントは、コードの一部に簡潔な説明を添えるのに最適で、/* ～ */を使った複数行コメントは、より詳細な説明やコード全体の動作を解説する際に有効です。
また、Kotlin特有の複数行コメントのネスト（入れ子）機能も紹介しました。これは他の言語にはあまり見られない特徴で、コメントの中にさらにコメントを書きたい場面でとても便利です。
コメントは、プログラムの実行には影響しませんが、初心者にとっては理解を深めるための手助けとなり、上級者にとっても将来の自分や他人がコードを読み返す際の重要な手がかりになります。
特に実務やチーム開発においては、他人が書いたコードを読む機会が多いため、誰が読んでも分かるように丁寧なコメントを残す習慣を身につけることが重要です。
実用的なコメントのサンプル
// 入力された年齢に基づいて成人かどうかを判定する関数
fun isAdult(age: Int): Boolean {
return age >= 20 // 20歳以上なら成人とみなす
}
このように、関数の目的や条件の意味をコメントに書き添えることで、コードを読む人が瞬時に意図を理解できます。
生徒
「Kotlinのコメントって簡単に使えるけど、意外と奥が深いですね。特にネストできるのは初めて知りました！」
先生
「その通りです。コメントはただの説明ではなく、コードを未来の自分や他人が理解するための“思いやり”でもあるんですよ。」
生徒
「なるほど…。これからは意味のあるコメントを心がけたいと思います！」
先生
「素晴らしい姿勢ですね。Kotlinでのコメントの基本を理解したことで、より良いコードが書けるようになりますよ。」
この記事を読んだ人からの質問
