Documentation with comments in Bash Scripting - Cheat Sheet & Quick Revision

Recall & Review

beginner

What is the purpose of comments in a Bash script?

Comments explain what the script or parts of it do. They help others and your future self understand the code easily.

beginner

How do you write a single-line comment in Bash?

Use the # symbol at the start of the line or before the comment text. Everything after # on that line is ignored by the shell.

intermediate

Why should you avoid putting sensitive information in comments?

Comments are visible to anyone who reads the script. Sensitive data like passwords should never be in comments to keep them secure.

beginner

Can comments affect the execution of a Bash script?

No, comments are ignored by the shell and do not affect how the script runs. They are only for humans reading the code.

intermediate

What is a good practice when writing comments in scripts?

Write clear, short comments that explain why something is done, not just what is done. Keep comments up to date with code changes.

Which symbol starts a comment in a Bash script?

A #

B //

C /*

D <!--

In Bash, the # symbol starts a comment. Everything after it on the same line is ignored.

What happens if you put a comment inside a Bash script?

A The script runs the comment as code

B The comment is printed to the screen

C The script crashes

D The script ignores it during execution

Comments are ignored by the shell and do not affect script execution.

Why is it important to keep comments updated?

A To reduce the script size

B To make the script run faster

C To avoid confusion when reading the script

D To hide code from others

Outdated comments can mislead readers, so keeping them updated helps understanding.

Which of these is NOT a good comment practice?

A Write long paragraphs explaining obvious code

B Explain why a code block exists

C Keep comments short and clear

D Avoid putting sensitive info in comments

Long paragraphs explaining obvious code can clutter scripts and reduce readability.

Where should you place comments in a Bash script?

A In a separate file only

B Before or beside the code they explain

C Inside strings

D Only at the end of the script

Comments should be near the code they describe to help readers understand easily.

Explain how to add comments in a Bash script and why they are useful.

Think about how you would explain your script to a friend.

Describe best practices for writing comments in scripts.

Focus on clarity and security.

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