当前位置: 首页>>代码示例 >>用法及示例精选 >>正文


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类。非经特殊声明,原始代码版权归原作者所有,本译文未经允许或授权,请勿转载或复制。