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.