18、Ruby 开发中的文档生成与包管理

Ruby 开发中的文档生成与包管理

1. RDoc 的使用

1.1 运行 RDoc

RDoc 是一个用于生成 Ruby 代码文档的工具，可通过命令行运行：

% rdoc [options] [filenames...]

若要查看最新的选项摘要，可输入 rdoc --help 。在生成输出之前，RDoc 会先解析文件并收集其中的信息，这样能解决所有文件之间的交叉引用问题。如果指定的名称是一个目录，RDoc 会遍历该目录。若未指定任何名称，RDoc 将处理当前目录（及子目录）中的所有 Ruby 文件。

例如，生成当前目录及其子目录下所有 Ruby 和 C 源文件的 HTML 文档，可使用以下命令：

% rdoc

生成的文档将存储在 doc/ 子目录开始的文档树中。

RDoc 根据文件扩展名来确定如何处理每个文件：
- 以 .rb 和 .rbw 结尾的文件名被假定为 Ruby 源文件。
- 以 .c 结尾的文件被解析为 C 文件。
- 其他文件被假定仅包含标记（带有或不带有开头的 # 注释标记）。

如果将目录名传递给 RDoc，它只会递归扫描其中的 C 和 Ruby 源文件。若要将非源文件