Comments and documentation in Ruby - Cheat Sheet & Quick Revision

Recall & Review

beginner

What is the purpose of comments in Ruby code?

Comments explain what the code does. They help people understand the code later. Ruby ignores comments when running the program.

beginner

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

Use the # symbol before the comment text. Everything after # on that line is a comment.

intermediate

What is a multi-line comment in Ruby and how is it written?

Ruby does not have a special multi-line comment syntax. Instead, you write multiple single-line comments starting each line with #.

beginner

Why is documentation important in programming?

Documentation helps others and your future self understand how to use and maintain the code. It saves time and reduces mistakes.

intermediate

What is a common way to document methods in Ruby?

Use comments above the method to describe what it does, its inputs, and outputs. This helps others know how to use the method.

How do you start a single-line comment in Ruby?

A #

B //

C /*

D <!--

In Ruby, single-line comments start with the # symbol.

What happens to comments when Ruby code runs?

A They are ignored

B They run as code

C They cause errors

D They print to the screen

Comments are ignored by Ruby when the program runs.

Which of these is NOT a reason to write comments?

A Explain code logic

B Make code run faster

C Help others understand code

D Document method usage

Comments do not affect how fast code runs; they only help with understanding.

How do you write multi-line comments in Ruby?

A Use <!-- and -->

B Use /* and */

C Use multiple lines starting with #

D Use ''' triple quotes

Ruby uses multiple single-line comments starting with # for multi-line comments.

Where should you place documentation comments for a method?

A In a separate file only

B Inside the method body

C After the method ends

D Above the method definition

Documentation comments are usually placed above the method to describe it.

Explain how to write comments in Ruby and why they are useful.

Think about how you tell a friend what your code does without changing the code.

Describe best practices for documenting methods in Ruby.

Imagine you are writing instructions for someone else to use your method.

Practice

1. What symbol is used to start a single-line comment in Ruby?

easy

A. #

B. //

C.

D. /*

Solution

1. Step 1: Identify single-line comment syntax in Ruby

   Ruby uses # to start a single-line comment.

2. Step 2: Compare with other options

   Options A, B, and C are comment symbols from other languages (JavaScript, HTML, C-style).

3. Final Answer:

   # -> Option A

4. Quick Check:

   Single-line comment = # [OK]

Hint: Single-line comments start with # in Ruby [OK]

Common Mistakes:

• Confusing Ruby comments with C-style or HTML comments
• Using // instead of #
• Trying to use /* */ for single-line comments

2. Which of the following is the correct way to write a multi-line comment in Ruby?

easy

A. //
This is a multi-line comment
//

B. /*
This is a multi-line comment
*/

C.

D. =begin
This is a multi-line comment
=end

Solution

1. Step 1: Recall Ruby multi-line comment syntax

   Ruby uses =begin and =end to mark multi-line comments.

2. Step 2: Check other options

   Options B, C, and D are multi-line comment styles from other languages (C, HTML, JavaScript).

3. Final Answer:

   =begin This is a multi-line comment =end -> Option D

4. Quick Check:

   Multi-line comment = =begin ... =end [OK]

Hint: Use =begin and =end for multi-line comments in Ruby [OK]

Common Mistakes:

• Using /* */ which is not valid in Ruby
• Using HTML style comments
• Trying to use // for multi-line comments

3. What will be the output of this Ruby code?

def greet(name)
  # This method returns a greeting message
  "Hello, #{name}!"
end

puts greet("Alice")

medium

A. greet

B. # This method returns a greeting message

C. Hello, Alice!

D. SyntaxError

Solution

1. Step 1: Understand the method and comment

   The comment line is ignored by Ruby and does not affect output. The method returns "Hello, #{name}!" with name replaced.

2. Step 2: Check the output of puts greet("Alice")

   It prints the string "Hello, Alice!" to the console.

3. Final Answer:

   Hello, Alice! -> Option C

4. Quick Check:

   Comment ignored, method returns greeting [OK]

Hint: Comments don't print; method returns greeting string [OK]

Common Mistakes:

• Thinking comments print output
• Confusing method name with output
• Expecting comment text to appear

4. Identify the error in this Ruby code snippet:

  =begin
This is a multi-line comment
# Another comment line
  =end
puts "Done"

medium

A. =begin and =end must be at the start of the line

B. The # inside multi-line comment causes error

C. Missing closing =end

D. Multi-line comment syntax is correct

Solution

1. Step 1: Check multi-line comment syntax rules

   In Ruby, =begin and =end must be at the start of the line with no leading spaces.

2. Step 2: Analyze the given code

   If =begin or =end are indented or not at line start, Ruby raises a syntax error.

3. Final Answer:

   =begin and =end must be at the start of the line -> Option A

4. Quick Check:

   Multi-line comment markers must start line [OK]

Hint: =begin and =end must start the line exactly [OK]

Common Mistakes:

• Indenting =begin or =end
• Thinking # inside multi-line comment causes error
• Forgetting to close multi-line comment

5. You want to document a Ruby method that takes a number and returns its square. Which comment style best describes the method's purpose and input/output?

hard

A. =begin
Squares a number
Input: num
Output: squared number
=end

B. # This method squares a number
# @param num [Integer] the number to square
# @return [Integer] the squared result

C. // Squares a number
// Input: num
// Output: squared number

D.

Solution

1. Step 1: Identify proper Ruby documentation comment style

   Ruby uses single-line comments with tags like @param and @return to document methods clearly.

2. Step 2: Compare options

   # This method squares a number # @param num [Integer] the number to square # @return [Integer] the squared result uses Ruby documentation style. =begin Squares a number Input: num Output: squared number =end uses multi-line comment but lacks tags. Options C and D use invalid comment styles for Ruby.

3. Final Answer:

   # This method squares a number # @param num [Integer] the number to square # @return [Integer] the squared result -> Option B

4. Quick Check:

   Use # with @param and @return for Ruby docs [OK]

Hint: Use # with @param and @return to document Ruby methods [OK]

Common Mistakes:

• Using multi-line comments without tags for documentation
• Using comment styles from other languages
• Not specifying input/output clearly