當前位置: 首頁>>代碼示例 >>用法及示例精選 >>正文


Ruby RDoc類用法及代碼示例


本文簡要介紹ruby語言中 RDoc::RDoc類 的用法。

這是生成 RDoc 輸出的驅動程序。它處理文件解析和輸出生成。

要使用該類通過 API 生成 RDoc 輸出,推薦的方式是:

rdoc = RDoc::RDoc.new
options = RDoc::Options.load_options # returns an RDoc::Options instance
# set extra options
rdoc.document options

您還可以生成像 rdoc 可執行文件這樣的輸出:

rdoc = RDoc::RDoc.new
rdoc.document argv

其中argv 是一個字符串數組,每個字符串對應於您在命令行中提供 rdoc 的參數。有關詳細信息,請參閱rdoc --help

相關用法


注:本文由純淨天空篩選整理自ruby-lang.org大神的英文原創作品 RDoc類。非經特殊聲明,原始代碼版權歸原作者所有,本譯文未經允許或授權,請勿轉載或複製。