コメントの書き方

このレッスンでは、Kotlinでコメントを書く方法を学び、コードの意図を人にも自分にも伝わりやすくすることを目標にします。「Kotlin コメント 書き方」で調べている方向けです。

コメントは、実行には影響しない「人間向けのメモ書き」です。//で1行、/* */で複数行のコメントになります。

サンプルコードでは、// これは1行コメントですのような行全体のコメントと、val price = 100 // 商品の価格(円)のようにコードの末尾に説明を加える書き方、さらに/* */で囲む複数行コメントの3パターンを確認できます。

初心者がよくつまずくのが、コメントを書きすぎて逆に読みにくくなることです。「なぜこの処理が必要なのか」という背景を書き残しておくと役立ちますが、コードを見れば分かることまで書く必要はありません。

実際の開発現場では、KDocという特殊な書き方を使うと、関数の説明をツールで自動生成することもできます。