Ruby Generator模块用法及代码示例

RDoc 使用生成器将解析的源代码以 RDoc::CodeObject 树的形式转换为某种形式的输出。 RDoc 带有 HTML 生成器 RDoc::Generator::Darkfish 和 ri 数据生成器 RDoc::Generator::RI。

注册 Generator

通过使用生成器的类调用 RDoc::RDoc.add_generator 来注册生成器：

class My::Awesome::Generator
  RDoc::RDoc.add_generator self
end

将 Options 添加到 rdoc

在选项处理之前rdoc,RDoc::Options将在生成器类上调用::setup_optionsRDoc::Options实例。生成器可以使用RDoc::Options#option_parser将命令行选项添加到rdoc工具。看RDoc::Options 处的自定义选项举个例子，看看OptionParser有关如何添加选项的详细信息。

您可以使用生成器的其他访问器扩展 RDoc::Options 实例。

Generator 实例化

解析后， RDoc::RDoc 将通过使用 RDoc::Store 实例和 RDoc::Options 实例调用初始化来实例化生成器。

RDoc::Store 实例包含已解析源代码的文档。在 RDoc 3 和更早的版本中， RDoc::TopLevel 类保存了这些数据。从 RDoc 3 和更早版本升级生成器时，您只需要将 RDoc::TopLevel 替换为商店实例。

RDoc 然后将在生成器实例上调用 generate。您可以在 RDoc::Store 和 RDoc::CodeObject 树中使用各种方法来创建所需的输出格式。