Kotlinコメントの書き方!//・/* */・KDoc・TODOの使い分け
生徒
「Kotlinでコメントってどうやって書くんですか?プログラムの中に説明を入れたいんですけど…」
先生
「Kotlinでは、//、/* */、KDoc、TODOやFIXMEなどを使って、コードの意図や注意点を残せます。」
生徒
「コメントにも種類があるんですね。使い分けを知りたいです!」
先生
「では、Kotlinのコメントの書き方と、実務で読みやすくするコツを順番に見ていきましょう。」
1. Kotlinのコメントとは?コードに人間向けの説明を残す仕組み
コメントとは、プログラムの中に書く人間向けの説明です。あとで自分が読み返すときや、ほかの人に処理の意図を伝えるときに役立ちます。Kotlinでは、コメントはコンピューターに無視されるため、処理や実行結果には影響しません。
まずは、コメントがあってもプログラムの動作が変わらないことを確認してみましょう。
fun main() {
// あいさつ文を表示する
println("Hello, Kotlin!")
println("コメントは実行結果に影響しません") // 行の途中にも書ける
}
Hello, Kotlin!
コメントは実行結果に影響しません
//以降は説明文として扱われます。プログラムとして実行されるのはprintlnなどのコード部分だけです。コメントは「何をしているか」だけでなく、「なぜこの処理が必要なのか」を残すために使うと、あとから読み返しやすいコードになります。
2. Kotlinの1行コメントの書き方!//で短いメモを残す
1行コメントは、//で始めた位置からその行の終わりまでがコメントになります。短い補足、処理の目的、作業中のメモを残したいときに便利です。
fun main() {
// ユーザー名を用意する
val user = "Taro"
// あいさつ文を表示する
println("Hi, $user!")
}
Hi, Taro!
コードの後ろにコメントを書くこともできます。ただし、行末コメントが長すぎると読みにくくなるため、短い補足にとどめるのがおすすめです。
fun main() {
val score = 80 // テストの点数
println(score)
}
また、テスト中に一時的に処理を止めたいときにも//はよく使われます。
fun main() {
// println("デバッグ用ログ")
println(1 + 1)
}
2
3. Kotlinの複数行コメントの書き方!/* */でまとまった説明を書く
複数行コメントは、/*で始まり、*/で終わります。複数行にわたる説明、処理の前提、注意点をまとめて書きたいときに使います。
fun main() {
/*
ここでは初期メッセージを表示します。
- 目的:最初の動作確認
- 注意:あとで文言を変更する可能性あり
*/
println("Hello, Kotlin!")
}
Hello, Kotlin!
複数行コメントは、複数の処理を一時的に無効化したいときにも使えます。ただし、最後の*/を書き忘れるとエラーになるため注意しましょう。
fun main() {
/*
println("A を表示")
println("B を表示")
*/
println("C だけ表示")
}
C だけ表示
4. //と/* */の使い分け!短い補足と長い説明を分ける
1行コメントと複数行コメントは、説明の長さと目的で使い分けます。短い補足なら//、処理の背景や注意点をまとめたいなら/* */が向いています。
- 1行コメント:短い補足、行末メモ、一時的な無効化
- 複数行コメント:仕様の説明、注意点、処理全体の前提
import kotlin.math.roundToInt
fun main() {
val price = 1200
val taxRate = 0.1
// 税込価格を四捨五入して整数にする
val total = (price * (1 + taxRate)).roundToInt()
/*
出力仕様
- 金額は「円」付きで表示
- 将来、通貨表示を変更する可能性あり
*/
println("合計: ${total}円")
}
合計: 1320円
ここではroundToInt()を使って四捨五入しています。toInt()は小数部分を切り捨てるため、「四捨五入」と説明したい場合はroundToInt()を使うと正確です。
5. Kotlinのコメントのネスト!複数行コメントを入れ子にする
Kotlinでは、複数行コメントの中にさらに複数行コメントを書くことができます。これをコメントのネスト、または入れ子と呼びます。大きな範囲を一時的にコメントアウトしたいときに便利です。
fun main() {
/*
これは外側のコメントです。
/*
これは内側のコメントです。
*/
println("ここはコメント内なので実行されません")
*/
println("Hello, Kotlin!")
}
Hello, Kotlin!
コメントをネストできると、すでに複数行コメントが含まれているコード全体を一時的に無効化しやすくなります。ただし、コメントの開始と終了が多くなると読みにくくなるため、使いすぎには注意しましょう。
6. KDocコメントの書き方!/** */で関数やクラスを説明する
KDocは、Kotlinで関数やクラスの説明を書くためのドキュメンテーションコメントです。通常の複数行コメントは/* */ですが、KDocでは/** */の形で書きます。関数の目的、引数、戻り値を説明したいときに役立ちます。
import kotlin.math.roundToInt
/**
* 税抜価格に消費税を加えた税込価格を返します。
*
* @param price 税抜価格
* @param taxRate 消費税率
* @return 四捨五入した税込価格
*/
fun calculateTotal(price: Int, taxRate: Double): Int {
return (price * (1 + taxRate)).roundToInt()
}
fun main() {
val total = calculateTotal(1200, 0.1)
println(total)
}
1320
@paramは引数の説明、@returnは戻り値の説明に使います。KDocを書くと、関数を呼び出す人が「何を渡せばよいか」「何が返ってくるか」を理解しやすくなります。特に、共通関数やクラスを作るときはKDocを添えておくと保守しやすくなります。
7. TODO・FIXMEコメントの使い分け!あとで直す場所を明確にする
TODOやFIXMEは、あとで対応したい作業や、修正が必要な場所を分かりやすく残すためのコメントです。IntelliJ IDEAやAndroid Studioなどの開発環境では、TODOコメントを一覧で確認できるため、作業漏れを防ぎやすくなります。
fun main() {
val userName = "Taro"
// TODO: 画面入力からユーザー名を受け取る処理に変更する
println("Hello, $userName!")
// FIXME: 空文字のときはエラーメッセージを表示する
}
Hello, Taro!
TODOは「あとで追加したい作業」、FIXMEは「今のままだと問題があるので修正したい箇所」に使うと分かりやすいです。
- TODO:未実装の処理、あとで追加する機能、改善予定のメモ
- FIXME:不具合の可能性がある処理、仮対応、早めに直すべきコード
8. Kotlinコメントの書き方を比較表で整理する
Kotlinのコメントは、種類ごとに役割が違います。どのコメントを使えばよいか迷ったときは、目的に合わせて選びましょう。
| コメント | 書き方 | 向いている場面 |
|---|---|---|
| 1行コメント | // コメント |
短い説明、行末メモ、一時的な無効化 |
| 複数行コメント | /* コメント */ |
複数行の説明、処理の前提、注意点の整理 |
| KDoc | /** コメント */ |
関数、クラス、引数、戻り値の説明 |
| TODO | // TODO: 対応内容 |
あとで実装する作業、改善予定のメモ |
| FIXME | // FIXME: 修正内容 |
不具合の可能性がある処理、早めに直したい箇所 |
初心者のうちは、短い説明には//、長い説明には/* */、関数の説明にはKDoc、あとで直す場所にはTODOやFIXMEを使う、と覚えると整理しやすいです。
9. 読みやすいコメントを書くコツ!書きすぎず理由を残す
コメントは多ければよいわけではありません。コードをそのまま説明するだけのコメントは、かえって読みにくくなることがあります。大切なのは、「なぜこの処理が必要なのか」「あとで注意すべきことは何か」を残すことです。
fun main() {
val age = 18
// 成人判定の境界値を確認するため、18歳を例にする
if (age >= 18) {
println("成人です")
} else {
println("未成年です")
}
}
成人です
このコメントは、単に「if文です」と説明しているのではなく、なぜ18という値を使っているのかを補足しています。コメントを書くときは、コードを読めば分かる内容ではなく、コードだけでは伝わりにくい意図や背景を書くと効果的です。
- コードをそのまま日本語にしすぎない
- 処理の理由や前提条件を短く書く
- 古いコメントを残したままにしない
- KDoc、TODO、FIXMEを目的に合わせて使う
まとめ
Kotlinでのコメントの書き方について学ぶことで、プログラムの可読性を高め、将来の保守やチーム開発において非常に役立つ知識を身につけることができました。//を使った1行コメントは、コードの一部に簡潔な説明を添えるのに最適で、/* ~ */を使った複数行コメントは、より詳細な説明やコード全体の動作を解説する際に有効です。
また、Kotlin特有の複数行コメントのネスト(入れ子)機能も紹介しました。これは他の言語にはあまり見られない特徴で、コメントの中にさらにコメントを書きたい場面でとても便利です。
コメントは、プログラムの実行には影響しませんが、初心者にとっては理解を深めるための手助けとなり、上級者にとっても将来の自分や他人がコードを読み返す際の重要な手がかりになります。
特に実務やチーム開発においては、他人が書いたコードを読む機会が多いため、誰が読んでも分かるように丁寧なコメントを残す習慣を身につけることが重要です。
実用的なコメントのサンプル
// 入力された年齢に基づいて成人かどうかを判定する関数
fun isAdult(age: Int): Boolean {
return age >= 20 // 20歳以上なら成人とみなす
}
このように、関数の目的や条件の意味をコメントに書き添えることで、コードを読む人が瞬時に意図を理解できます。
生徒
「Kotlinのコメントって簡単に使えるけど、意外と奥が深いですね。特にネストできるのは初めて知りました!」
先生
「その通りです。コメントはただの説明ではなく、コードを未来の自分や他人が理解するための“思いやり”でもあるんですよ。」
生徒
「なるほど…。これからは意味のあるコメントを心がけたいと思います!」
先生
「素晴らしい姿勢ですね。Kotlinでのコメントの基本を理解したことで、より良いコードが書けるようになりますよ。」
Kotlinを基礎からしっかり学びたい人や、 Java経験を活かしてモダンな言語にステップアップしたい人には、 定番の入門書がこちらです。
基礎からわかるKotlinをAmazonで見る※ Amazon広告リンク
この記事を読んだ人からの質問
プログラミング初心者からのよくある疑問/質問を解決します
Kotlinでコメントを使う理由って何ですか?コードに説明を書く必要がありますか?
Kotlinでコメントを使う理由は、コードの意図や動作を他人や将来の自分が理解しやすくするためです。説明を入れておくことで、保守やチーム開発がスムーズになります。
Kotlinの1行コメントと複数行コメントの違いは何ですか?
Kotlinの1行コメントは「//」を使って短い説明を書くのに適しており、複数行コメントは「/* ~ */」を使って長めの説明やコードブロックの一時無効化などに使います。
Kotlinの複数行コメントは入れ子(ネスト)にできますか?
はい、Kotlinでは複数行コメントを入れ子にすることができます。他の多くのプログラミング言語ではできない機能なので、Kotlinの特徴のひとつです。
Kotlinのコメントは実行結果に影響しますか?
いいえ、Kotlinのコメントはあくまで説明のためのもので、プログラムの動作や実行結果には一切影響しません。
【未経験OK】Kotlinで始めるプログラミング入門|ゼロから「動く喜び」を体験する60分
「プログラミングを始めたい」を形にする。最新言語Kotlinで楽しむ、ものづくりの第一歩。
本講座は、プログラミング経験が全くない方のためのエントリー講座です。「コードを書くってどういうこと?」という基本から、世界中で使われている最新言語Kotlin(コトリン)を使って、実際にプログラムを動かすまでを体験します。難しい理屈よりも、まずは「自分の手で動かす楽しさ」を最短距離で実感していただきます。
具体的な体験内容と環境
【つくるもの】
簡単な言葉を入力すると自動で返答してくれる「対話型ミニプログラム」や、計算を自動化する「便利ツール」をゼロから作成します。黒い画面に自分の書いた文字が表示される瞬間は、最高の感動体験です。
【開発環境】
プロのエンジニアが実際に使っている開発ツールIntelliJ IDEA(インテリジェイ)をインストールします。ボタン一つで日本語化し、初心者でも迷わず操作できる「魔法の設定」を一緒に行います。
この60分で得られる3つの体験
プロと同じ道具を揃えることで、明日から一人でもプログラミングを続けられる環境が整います。
「変数」や「型」といった難しい言葉も、身近な例え話で解説。モヤモヤをゼロにします。
Kotlinは英語に近くて読みやすいのが特徴。自分でコードを読んで、間違いを見つけるコツも伝授します。
※本講座は、パソコン操作が不安な方でも安心して受講いただける完全マンツーマンです。あなたのペースに合わせて、一つずつ丁寧に進めていきます。
Kotlinで始めるプログラミング入門|ゼロから「動く喜び」を体験