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 樹中使用各種方法來創建所需的輸出格式。