Comments and documentation markup in Swift - Mini Project: Build & Apply

Comments and documentation markup

📖 Scenario: Imagine you are writing a simple Swift program to keep track of a book's details. You want to make sure your code is easy to understand for others and for yourself in the future.

🎯 Goal: You will create a Swift program that uses comments and documentation markup to explain what the code does. This will help anyone reading your code understand its purpose and details.

📋 What You'll Learn

Create a variable with a book title

Add a single-line comment explaining the variable

Add a multi-line comment describing the program

Use documentation markup to describe a function

💡 Why This Matters

🌍 Real World

Comments and documentation help programmers understand code quickly, especially when working in teams or returning to old projects.

💼 Career

Clear comments and documentation are essential skills for software developers to write maintainable and readable code.

1

Create a variable with a comment

Create a variable called bookTitle and set it to the string "The Swift Guide". Add a single-line comment above it that says // This is the title of the book.

Swift

# Create the variable bookTitle with a comment above
// Your code here

Need a hint?

Use // for a single-line comment just above the variable.

2

Add a multi-line comment

Add a multi-line comment at the top of the program that says:
/* This program stores information about a book.
It uses comments to explain the code. */

Swift

/* Add a multi-line comment here explaining the program */
// This is the title of the book
var bookTitle = "The Swift Guide"

Need a hint?

Use /* to start and */ to end a multi-line comment.

3

Add a function with documentation markup

Create a function called printBookTitle() that prints the bookTitle. Add documentation markup above the function using /// to describe that the function prints the book title.

Swift

/* This program stores information about a book.
It uses comments to explain the code. */
// This is the title of the book
var bookTitle = "The Swift Guide"

// Add the function printBookTitle() with documentation markup below
// Your code here

Need a hint?

Use /// for documentation comments just above the function.

4

Call the function and print output

Call the function printBookTitle() to display the book title.

Swift

/* This program stores information about a book.
It uses comments to explain the code. */
// This is the title of the book
var bookTitle = "The Swift Guide"

/// Prints the book title to the console
func printBookTitle() {
    print(bookTitle)
}

// Call the function printBookTitle() below
// Your code here

Need a hint?

Simply write printBookTitle() to call the function.