Ruby Documentation Flashcard

Front

What is the purpose of documenting Ruby code?

Back

To guard against code amnesia

Front

What does RDoc stand for?

Back

Ruby Documentation

Front

What type of output does RDoc generate?

Back

Structured HTML documentation

Front

How do you run RDoc from the command line?

Back

rdoc person.rb

Front

What does the :nodoc: modifier do?

Back

It ignores the method in documentation.

Front

What is the default output directory for RDoc documentation?

Back

doc

Front

What is the purpose of the #++ and #-- comments in RDoc?

Back

To stop and start RDoc processing

Front

What does RDoc automatically recognize in comments?

Back

Paragraphs and structure

Front

What is the first step to document a class using RDoc? Options: Run RDoc on the class file, Leave comments before the class definition, Write the class definition, Create a README file

Back

Leave comments before the class definition

Front

What does RDoc use to generate documentation for methods?

Back

Comments and method definitions