Kotlinにおけるコメントは、コードに説明やメモを加えるために使用される構文要素であり、実行時には無視されます。コメントはコードの可読性を高め、他の開発者や将来の自分がコードの意図を理解しやすくするために非常に重要です。
Kotlinのコメントには、2種類があります。
1. 行コメント(シングルラインコメント)
行コメントは、// を使って記述し、その行の末尾までがコメントとして扱われます。
例
-
//の右側の文字列はすべてコメントとして扱われ、コンパイルされません。 -
主に短い説明やメモに使用されます。
2. ブロックコメント(複数行コメント)
ブロックコメントは、/* で開始し、*/ で終了します。複数行にわたる説明や、コードの一時的な無効化に使用されます。
例
-
ブロックコメントの中には、改行や任意の文字列を含めることができます。
-
Kotlinではネスト(入れ子)したブロックコメントもサポートされています。
ネストの例
これはJavaにはない特徴で、複数人での共同開発時などに役立ちます。
コメントの使用上の注意
-
コメントは「コードを補完するもの」であり、「コードの代替」ではありません。読まなくても分かるコードを書くことが基本であり、コメントは補足的に使うべきです。
-
不必要に冗長なコメントや、古くなって意味をなさないコメントは削除するのが望ましいです。
まとめ
| 種類 | 開始記号 | 終了記号 | 特徴 |
|---|---|---|---|
| 行コメント | // |
行末まで | 単一行の説明に使用される |
| ブロックコメント | /* |
*/ |
複数行やネストされたコメントに対応 |
生成日:2025/05/04