18、Ruby开发中的RDoc与RubyGems使用指南

Ruby开发中的RDoc与RubyGems使用指南

1. RDoc的使用

1.1 运行RDoc

RDoc可以通过命令行运行，基本命令格式如下：

% rdoc [options] [filenames...]

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

例如，要为一个Ruby源包（如RDoc本身）生成文档，可使用以下命令：

% rdoc

此命令会为当前目录及其子目录中的所有Ruby和C源文件生成HTML文档，并将这些文档存储在 doc/ 子目录下的文档树中。

1.2 文件处理规则

RDoc根据文件扩展名来确定如何处理每个文件：
- 以 .rb 和 .rbw 结尾的文件名被视为Ruby源文件。
- 以 .c 结尾的文件会被解析为C文件。
- 其他文件则被假定仅包含标记（无论是否带有前导 # 注释标记）。

若将目录名传递给RDoc，它只会递归扫描其中的C和Ruby源文件。若要将非源文件（如README文件）包含在文档处理过程中，则必须在命令行中明确指