Kotlin コメントの書き方

Kotlin×Android

2024.09.282025.02.17

Table of Contents

コメントの基本

kotlinでコメントを記述する方法は色々ありますが、主に2種類のコメントがあります。

・1行コメント　(シングルラインコメント)

・複数行コメント (マルチラインコメント)

1行コメントは、1行のコメントを書きたい場合に使用します。「//」の後ろにコメントを記述します。

Kotlin

//これは1行コメントです。

1行コメントは、その行の終わりまでがコメントとして扱われ、無視されます。主にコードの簡単な説明や注釈を記述するのに適しています。

行頭のみではなく、コードの後ろに記述して使用することもできます。
下の例では、「name = Neko」は実行されます。

Kotlin

name = Neko //nameにNekoを代入します。

マルチラインコメントは、ブロック単位でコメントを記述する際に便利です。
「/*」と「*/」で囲まれた行がすべてコメントとして無視されます。

Kotlin

/*
ここはコメントです。
ここもコメントです。
なんと、ここもコメントです。
*/

kotolinにはその他にも、「ドキュメンテーションコメント」や「TODOコメント」があるそうです。

コメントはコードを補完するものであり、過剰に書きすぎると逆にコードの可読性を下げることがあります。自己説明的なコードを書くことが最優先です。

コードが変更された場合、コメントも更新することを忘れないでください。古いコメントは誤解を招く可能性があります。

コメントは簡潔かつ明確にするべきです。何を説明したいのかをはっきりと書きましょう。

Kotlinでのコメントの書き方は、非常にシンプルですが、効果的に使うことでコードの理解を深め、メンテナンスがしやすいコードを作成する手助けとなります。適切なコメントを活用して、より良いコードを書きましょう。

コメントを書かないと、未来の自分が探偵になるはめになる。