Bird
0
0

Which of the following is the correct way to document a method parameter using YARD?

easy📝 Syntax Q12 of 15
Ruby - Ecosystem and Best Practices
Which of the following is the correct way to document a method parameter using YARD?
A# @param name [String] the user's name
B// @param name String the user's name
C/* @param name String the user's name */
D<!-- @param name String the user's name -->
Step-by-Step Solution
Solution:

  1. Step 1: Recognize Ruby comment style

    Ruby uses # for single-line comments, so YARD tags must start with #.

  2. Step 2: Identify correct YARD tag syntax

    The correct format is "# @param name [Type] description".

  3. Final Answer:

    # @param name [String] the user's name -> Option A

  4. Quick Check:

    # -> Ruby comments [OK]
Quick Trick: YARD tags start with # in Ruby code comments [OK]
Common Mistakes:
  • Using comment styles from other languages
  • Omitting square brackets around type
  • Writing tags inside HTML or block comments

Want More Practice?

15+ quiz questions · All difficulty levels · Free

Free Signup - Practice All Questions
More Ruby Quizzes
Advanced Metaprogramming - DSL building patterns - Quiz 1easy Concurrent Programming - Process forking for parallelism - Quiz 2easy Functional Patterns in Ruby - Why functional patterns complement OOP - Quiz 13medium Metaprogramming Fundamentals - Open struct for dynamic objects - Quiz 13medium Metaprogramming Fundamentals - Method_missing for catch-all - Quiz 12easy Metaprogramming Fundamentals - Instance_variable_get and set - Quiz 8hard Metaprogramming Fundamentals - Class.new for dynamic class creation - Quiz 2easy Regular Expressions - Match operator (=~) - Quiz 9hard Regular Expressions - Scan for all matches - Quiz 10hard Testing with RSpec and Minitest - Minitest basics (assert style) - Quiz 14medium