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

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

1. 文档编写

1.1 RDoc 简介

在开发 Ruby 代码时，即使是自己使用的代码，随着时间推移也可能忘记其实现细节和工作原理。为避免这种情况，需要对代码进行文档编写。Ruby 提供了 RDoc（Ruby Documentation）工具，它能根据代码结构和注释生成结构化的 HTML 文档，且该工具随 Ruby 标准发行版提供，易于使用。若安装的 Ruby 中未包含 RDoc，可从 官方网站 下载。

1.2 使用 RDoc 生成文档

要使用 RDoc 生成文档，需在类、方法或模块定义前添加注释。例如：

# 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 <文件名>.rb 即可生