Kotlin

【Kotlin入門】コメントの基本パターンの書き方(3種類)

前回、Kotlin で「Hello, World」を試してみました。

【Kotlin入門】「Hello World」を1分で試すKotlin がどんなものかは他のサイトを見てもらうとして、これから少しずつ Kotlin を覚えることになるかもしれないからお決まりの...

今回から Kotlin のプログラム言語について少しずつ勉強していきます。

まずはコメントの書き方から進めていきますよ。

Kotlinのコメントの種類

Kotlin で用意されているコメントは主に 2 種類あります。

  • 1行コメント
  • 複数行コメント

コメントに使う文字や記号は言語によって多少の違いはあるものの、種類という意味では大きく変わりません。

ちなみに、Kotlin のコメントは Java や PHP と同じなので、それらの言語を経験したことのある人であれば違和感なく使えます。

f:id:chatoracat:20181025234005j:plain

1行コメント

スラッシュを 2 つ連続させると、それ以降がコメントとして扱われます。

1行コメントの場合は以下のように書きます。

// Hello Worldを出力
println(“Hello, world!”)

もちろん行の途中に書くこともできます。

println(“Hello, world!”) // 行末にセミコロンは不要

ロジックの中で注目させたい処理などの場合、下記のように書くケースもありますよね。

このあたりは好みもありますが、携わるプロジェクトなどで自分だけ逸脱していなければ問題ないと考えています。

複数行コメント

一時的に不要になったプログラムなど、複数行をまとめてコメントアウトすることもできます。

その場合は、/ から / までをコメントとして扱います。

また、クラスやメソッドの説明で /** から始まるコメントを付けることが多いと思いますが、Kotlin も同様になります。

Java だと JavaDoc、PHP だと PHPDoc がありますが、Kotlin では KDoc を出力する情報として書くことができます。