25、Ruby 编程：文档编写、错误处理、调试与测试全解析

Ruby 编程：文档编写、错误处理、调试与测试全解析

在软件开发过程中，文档编写、错误处理、调试和测试是确保程序可靠性的关键环节。这些任务虽常被忽视，但对整体开发流程的重要性不亚于常规编码。本文将深入探讨如何利用 Ruby 自带的工具完成这些任务。

文档编写

即使你是唯一使用和维护 Ruby 代码的人，随着时间推移，也难免会忘记代码的实现细节和工作原理。因此，在开发过程中编写代码文档是非常必要的。

传统上，文档编写工作常由第三方完成，或在大部分开发工作结束后进行。开发者虽会在代码中添加注释，但能让其他开发者和用户在不查看源代码的情况下理解代码的高质量文档却并不常见。

Ruby 提供了一个名为 RDoc（Ruby Documentation）的实用工具，让代码文档编写变得轻而易举。

• 使用 RDoc 生成文档 ：
  RDoc 是一个用于读取 Ruby 源代码文件并生成结构化 HTML 文档的工具，它随 Ruby 标准发行版提供，易于查找和使用。若你的 Ruby 安装中未包含 RDoc，可从官方网站（http://rdoc.sourceforge.net/）下载。

RDoc 能理解大量 Ruby 语法，无需太多提示就能为类、方法、模块等 Ruby 结构生成文档。要让 RDoc 能利用你的注释生成文档，需在要文档化的类、方法或模块定义之前添加注释。示例代码如下：

# This class stores information about people.
class Person