Kotlin Comments

Comments can be used to explain Kotlin code, and to make it more readable. It can also be used to prevent execution when testing alternative code.

Single-line Comments

Single-line comments start with two forward slashes (//).

Any text between // and the end of the line is ignored by Kotlin (will not be executed).

This example uses a single-line comment at the end of a line of code:

// This is a comment
println("Hello World")

Multi-line Comments

Multi-line comments start with /* and ends with */.

Any text between /* and */ will be ignored by Kotlin.

This example uses a multi-line comment (a comment block) to explain the code:

/* The code below will print the words Hello World
to the screen, and it is amazing */

println("Hello World")

Shortcut Windows/linux :

  • Line Comment hold both: Ctrl + /
  • Block Comment hold all three: Ctrl + Shift + /

  • Same way to remove the comment block.
  • To Provide Method Documentation comment type /** and press Enter just above the method name (
  • It will create a block comment with a parameter list and return type like this
* @param userId
* @return

public fun getUserDetails(userId : String){}