Comments and documentation syntax in Kotlin - Mini Project: Build & Apply

Comments and Documentation Syntax in Kotlin

📖 Scenario: You are writing a simple Kotlin program to keep track of a book's title and author. To make your code clear for others and yourself, you will add comments and documentation.

🎯 Goal: Learn how to write single-line comments, multi-line comments, and documentation comments in Kotlin.

📋 What You'll Learn

Create variables with exact names and values

Add a single-line comment explaining a variable

Add a multi-line comment explaining a block of code

Add a documentation comment for a function

Print the book details

💡 Why This Matters

🌍 Real World

Comments and documentation help programmers understand code quickly and maintain it easily, especially in team projects or when returning to code after some time.

💼 Career

Clear comments and documentation are essential skills for software developers to communicate their code's purpose and usage effectively.

1

Create variables for book title and author

Create two variables called bookTitle and bookAuthor. Set bookTitle to "The Kotlin Guide" and bookAuthor to "Jane Doe".

Kotlin

# Your code here

Need a hint?

Use val to create variables with the exact names and values.

2

Add a single-line comment for the book title

Add a single-line comment above the bookTitle variable that says // This is the title of the book.

Kotlin

// Your comment here
val bookTitle = "The Kotlin Guide"
val bookAuthor = "Jane Doe"

Need a hint?

Use // to write a single-line comment exactly as shown.

3

Add a multi-line comment explaining the variables

Add a multi-line comment above both variables that says exactly: /* This section defines the book details including title and author */

Kotlin

/*
Your multi-line comment here
*/
// This is the title of the book
val bookTitle = "The Kotlin Guide"
val bookAuthor = "Jane Doe"

Need a hint?

Use /* and */ to write a multi-line comment exactly as shown.

4

Add a documentation comment for a function and print book details

Create a function called printBookDetails with no parameters. Add a documentation comment above it that says exactly: /** * Prints the book title and author */. Inside the function, print bookTitle and bookAuthor on separate lines using println. Then call printBookDetails().

Kotlin

/*
This section defines the book details
including title and author
*/
// This is the title of the book
val bookTitle = "The Kotlin Guide"
val bookAuthor = "Jane Doe"

// Your function and call here

Need a hint?

Use /** */ for documentation comments and println to print each variable.