A simple class that's been documented using comments.
# This class stores information about people.
class Person
attr_accessor :name, :age, :gender
# Create the person object and store their name
def initialize(name)
@name = name
end
# Print this person's name to the screen
def print_name
puts "Person called #{@name}"
end
end
# RDoc can turn it into a pretty set of HTML documentation in seconds.
# rdoc person.rb
Related examples in the same category