Ruby Options類用法及代碼示例

RDoc::Options 處理選項的解析和存儲

已保存 Options

您可以在 gem 的 .rdoc_options 文件中保存一些選項，例如標記格式。最簡單的方法是：

rdoc --markup tomdoc --write-options

這將自動創建文件並用您指定的選項填充它。

以下選項不會被保存，因為它們會幹擾用戶的偏好或 RDoc 的正常運行：

• --coverage-report

• --dry-run

• --encoding

• --force-update

• --format

• --pipe

• --quiet

• --template

• --verbose

自定義 Options

生成器可以掛接到 RDoc::Options 以添加 generator-specific 命令行選項。

當在 ARGV 中遇到 --format 時， RDoc 在生成器類上調用::setup_options 以向選項解析器添加額外的選項。自定義生成器的 Options 必須出現在 --format 之後。 rdoc --help 將列出所有已安裝生成器的選項。

例子：

class RDoc::Generator::Spellcheck
  RDoc::RDoc.add_generator self

  def self.setup_options rdoc_options
    op = rdoc_options.option_parser

    op.on('--spell-dictionary DICTIONARY',
          RDoc::Options::Path) do |dictionary|
      rdoc_options.spell_dictionary = dictionary
    end
  end
end

當然，默認情況下 RDoc::Options 不響應 spell_dictionary 所以你需要添加它：

class RDoc::Options

  ##
  # The spell dictionary used by the spell-checking plugin.

  attr_accessor :spell_dictionary

end

選項驗證器

OptionParser 驗證器將驗證並轉換用戶輸入值。除了 OptionParser ( String , Integer , Float , TrueClass , FalseClass , Array , Regexp , Date , Time , URI 等)附帶的驗證器之外， RDoc::Options 還添加了 Path 、 PathArray 和 Template 。