这是可以使用我们的多个免费在线工作站之一在 OnWorks 免费托管服务提供商中运行的命令 rdoc，例如 Ubuntu Online、Fedora Online、Windows 在线模拟器或 MAC OS 在线模拟器
程序：
您的姓名
rdoc2.3 - 从 Ruby 脚本文件生成文档
概要
rdoc2.3 [选项] [名称...]
商品描述
在任何输出被解析之前，文件被解析，并且它们包含的信息被收集
产生。 这允许解析所有文件之间的交叉引用。 如果一个名字是一个
目录，它被遍历。 如果未指定名称，则当前所有 Ruby 文件
目录（和子目录）被处理。
可用的输出格式化程序：chm、html、ri、xml
有关输出去向的信息，请使用：
rdoc --help-输出
配置
--存取器， -A 访问者名[,..]
应该像对待的其他类方法的逗号分隔列表
'attr_reader' 和朋友们。 选项可以重复。 每个访问者名可能有
'=text' 附加，在这种情况下，文本出现在 r/w/rw 出现的位置
普通存取器。
- 全部， -a
在输出中包含所有方法（不仅仅是公共方法）。
--字符集， -c 字符集
指定 HTML 字符集
--调试， -D
在内部物品上显示很多
- 图表， -d
生成显示模块和类的图表。 需要dot V1.8.6或更高版本才能使用
--diagram 选项正确。 点可从
<网址：http://www.research.att.com/sw/tools/graphviz/>.
- 排除， -x 模式
不处理匹配模式的文件或目录。 明确给出的文件
命令行永远不会被排除在外。
- 延期， -E 新 = 旧
将以 .new 结尾的文件视为以 .old 结尾。 使用 '-E cgi=rb' 将
导致 xxx.cgi 被解析为 Ruby 文件
--文件箱， -F
类放置在代表文件的框中，这些类位于其中。
在多个文件之间共享的类与共享的文件列表一起显示
他们。 如果未给出 --diagram 实验，则无声地丢弃。
--fmt， -f 格式名
设置输出格式化程序（见下文）。
- 帮助， -h
打印使用。
--帮助输出， -O
解释各种输出选项。
- 图像格式， -I gif|png|jpg|jpeg
设置图表的输出图像格式。 可以是 png、gif、jpeg、jpg。 如果这个选项
省略，使用png。 需要 --diagram。
- 包括， -i 目录[,目录...]
设置（或添加到）满足 :include 时要搜索的目录列表：
要求。 可以多次使用。
--内联源， -S
内联显示方法源代码，而不是通过弹出链接。
--行号， -N
在源代码中包含行号
- 主要的， -m 姓名
name 将是显示的初始页面。
- 合并， -M
创建 ri 输出时，将处理过的类合并到以前记录的类中
名字的名字。
--一个文件， -1
将所有输出放入一个文件中。
——操作， -o DIR
设置输出目录。
--操作名， -n 姓名
设置输出的名称。 对 HTML 没有影响。
- 淫乱， -p
当记录包含在其他文件中定义的模块或类的文件时
文件，在每个文件页面中显示该模块/类的所有内容。 默认情况下，只有
显示该特定文件中定义的内容。
- 安静的， -q
在我们解析时不要显示进度。
——里， -r
生成供“ri”使用的输出。 文件存储在“.rdoc”目录中
在您的主目录下，除非被后续的 --op 参数覆盖，所以没有
需要特殊的特权。
--ri-网站， -R
生成供“ri”使用的输出。 文件存储在站点范围的目录中，
使他人可以访问它们，因此需要特殊权限。
--ri系统， -Y
生成供“ri”使用的输出。 文件存储在系统级目录中，
使他人可以访问它们，因此需要特殊权限。 这个选项是
旨在在 Ruby 安装期间使用。
--显示哈希， -H
注释中#name 形式的名称可能是指向实例方法的超链接
姓名。 显示时，除非指定了此选项，否则将删除“#”。
- 风格， -s 样式表网址
指定单独样式表的 URL。
--标签宽度， -w n
设置制表符的宽度（默认为 8）。
- 模板， -T 模板名称
设置生成输出时使用的模板。
- 标题， -t 文本
将文本设置为输出的标题。
- 版本， -v
显示 RDoc 的版本。
--webcvs， -W 网址
指定用于链接到 CVS 的 Web 前端的 URL。 如果 URL 包含一个包含一个
'%s'，文件名将被附加到它。
2014 年 7 月 RDOC2.3(1)
使用 onworks.net 服务在线使用 rdoc
