Documentation with comments in Bash Scripting - Practice Problems & Coding Challenges

Challenge - 5 Problems

💻 Command Output

intermediate

What is the output of this commented Bash script?

Consider the following Bash script with comments. What will it print when run?

Bash Scripting

#!/bin/bash
# This script prints a greeting

echo "Hello, world!"  # Print greeting

A Hello, world!

B # This script prints a greeting

C echo "Hello, world!"

D No output

💡 Hint

Comments start with # and are ignored by the shell.

The script prints the text inside echo. Comments are ignored and do not print.

📝 Syntax

intermediate

Which option correctly comments out a line in Bash?

In Bash scripting, how do you comment out a single line?

A // This is a comment

B <!-- This is a comment -->

C # This is a comment

D /* This is a comment */

💡 Hint

Bash uses a special character at the start of the line for comments.

In Bash, the # character starts a comment until the end of the line.

🔧 Debug

advanced

Why does this script print the comment text?

Look at this Bash script: #!/bin/bash #echo "Hello" echo "#Hello" Why does it print '#Hello' instead of nothing?

A Because the script has a syntax error

B Because the # inside quotes is treated as text, not a comment

C Because the # is ignored only at the start of the line

D Because echo always prints comments

💡 Hint

Think about how quotes affect comments in Bash.

Comments start with # only outside quotes. Inside quotes, # is normal text.

🚀 Application

advanced

Add comments to explain this Bash script

Here is a Bash script: #!/bin/bash for i in {1..3}; do echo "Number $i" done Which option shows the script with clear comments added?

A

#!/bin/bash
for i in {1..3}; do
  echo "Number $i"
done # Loop ends

B

#!/bin/bash
for i in {1..3}; do
  echo "Number $i" # Loop
# done

C

#!/bin/bash
for i in {1..3}; do
  echo "Number $i"
# done

D

#!/bin/bash
# Loop from 1 to 3
for i in {1..3}; do
  # Print the current number
  echo "Number $i"
done

💡 Hint

Good comments explain what each part does clearly.

Option D adds comments before the loop and inside it explaining the purpose clearly.

🧠 Conceptual

expert

What is the purpose of comments in Bash scripts?

Why do we add comments in Bash scripts? Choose the best answer.

A To explain the code to humans and make it easier to understand and maintain

B To make the script run faster by skipping commented lines

C To prevent the script from running any commands

D To encrypt the script content for security

💡 Hint

Think about who reads comments and why.

Comments help people understand the code but do not affect how the script runs.

Practice

1. What is the main purpose of comments in a Bash script?

easy

A. To explain what the code does for better understanding

B. To make the script run faster

C. To change the output of the script

D. To store variables for later use

Solution

1. Step 1: Understand the role of comments

   Comments are lines starting with # that explain the code but do not affect execution.

2. Step 2: Identify the correct purpose

   Comments help humans understand the script, not the computer or output.

3. Final Answer:

   To explain what the code does for better understanding -> Option A

4. Quick Check:

   Comments explain code = D [OK]

Hint: Comments explain code, they don't affect running [OK]

Common Mistakes:

• Thinking comments speed up scripts
• Believing comments change output
• Confusing comments with variables

2. Which of the following is the correct way to write a comment in a Bash script?

easy

A. // This is a comment

B. # This is a comment

C.

D. /* This is a comment */

Solution

1. Step 1: Recall Bash comment syntax

   Bash comments start with the # symbol and continue to the end of the line.

2. Step 2: Match the correct syntax

   Only # This is a comment uses # correctly; others are for other languages.

3. Final Answer:

   # This is a comment -> Option B

4. Quick Check:

   Bash comments start with # = B [OK]

Hint: Bash comments always start with # [OK]

Common Mistakes:

• Using // like in JavaScript
• Using /* */ like in C
• Using HTML comment style

3. What will be the output of this script?

#!/bin/bash
# Print greeting message
echo "Hello, world!"  # This prints the message

medium

A. This prints the message

B. # Print greeting message

C. Hello, world!

D. No output

Solution

1. Step 1: Identify executable lines

   Lines starting with # are comments and ignored; only echo prints output.

2. Step 2: Determine output of echo command

   echo "Hello, world!" prints Hello, world! exactly.

3. Final Answer:

   Hello, world! -> Option C

4. Quick Check:

   Comments ignored, echo prints text = C [OK]

Hint: Only echo prints; comments do not show in output [OK]

Common Mistakes:

• Thinking comments print
• Confusing inline comments as output
• Expecting comment text to appear

4. Identify the error in this Bash script snippet:

#!/bin/bash
# This is a comment
#echo "Hello"
echo "World"

medium

A. The line '#echo "Hello"' is treated as a comment and not executed

B. The comment symbol # is missing

C. The echo command is misspelled

D. The script will print both Hello and World

Solution

1. Step 1: Analyze the commented line

   The line '#echo "Hello"' starts with #, so it is a comment and ignored.

2. Step 2: Check script output

   Only echo "World" runs, so only 'World' prints, not 'Hello'.

3. Final Answer:

   The line '#echo "Hello"' is treated as a comment and not executed -> Option A

4. Quick Check:

   Lines starting with # are comments = A [OK]

Hint: Lines starting with # are never executed [OK]

Common Mistakes:

• Thinking commented lines run
• Missing # on comment lines
• Expecting both outputs

5. You want to add a comment explaining a complex command in your Bash script. Which is the best practice?

hard

A. Add the comment without # anywhere in the script

B. Place the comment on the same line after the command using #

C. Put the comment inside double quotes after the command

D. Write the comment on the line before the command starting with #

Solution

1. Step 1: Understand comment placement

   Comments before commands clearly explain what the command does before it runs.

2. Step 2: Evaluate options

   Comments inside quotes or without # are treated as code or cause errors; inline comments are okay but less clear for complex commands.

3. Final Answer:

   Write the comment on the line before the command starting with # -> Option D

4. Quick Check:

   Comments before commands improve clarity = A [OK]

Hint: Put comments before complex commands for clarity [OK]

Common Mistakes:

• Putting comments inside quotes
• Omitting # for comments
• Adding comments after commands for complex lines