9、Ruby 开发中的文档、错误处理、调试与测试

Ruby 开发中的文档、错误处理、调试与测试

1. 文档编写

在开发 Ruby 代码时，即使只有自己使用，随着时间推移，也难免会忘记代码的实现细节和工作原理。因此，在开发过程中对代码进行文档编写是很有必要的。

1.1 使用 RDoc 生成文档

RDoc 是 Ruby 自带的一个工具，它可以读取 Ruby 源代码文件并生成结构化的 HTML 文档。以下是使用 RDoc 的步骤：
1. 在要文档化的类、方法或模块定义之前添加注释，例如：

# 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

2. 在命令行中运行 rdoc <源文件名>.rb 来生成文档，例如：

rdoc person.rb

在 Linux 和 OS X 系统中，只要