9、Ruby 开发：文档、错误处理、调试与测试全解析

Ruby 开发：文档、错误处理、调试与测试全解析

1. 文档编写

在开发过程中，文档编写是一项容易被忽视但至关重要的工作。即使你是代码的唯一使用者，随着时间推移，也难免会忘记代码的细节和实现方式。因此，在开发过程中及时记录代码是很有必要的。

1.1 RDoc 工具介绍

Ruby 提供了一个名为 RDoc（Ruby Documentation）的实用工具，它可以根据 Ruby 源代码文件生成结构化的 HTML 文档。RDoc 随 Ruby 标准发行版提供，易于查找和使用。如果你的 Ruby 安装中没有包含 RDoc，可以从官方网站 http://rdoc.sourceforge.net/ 下载。

1.2 使用 RDoc 生成文档

要使用 RDoc 生成文档，只需在命令行中运行 rdoc <源文件名>.rb 命令。例如，有一个简单的 Ruby 类 Person ：

# 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