这是 yardoc 命令，可以使用我们的多个免费在线工作站之一在 OnWorks 免费托管服务提供商中运行，例如 Ubuntu Online、Fedora Online、Windows 在线模拟器或 MAC OS 在线模拟器
程序：
您的姓名
yardoc - 用于为 Ruby 编程语言生成文档的 Ruby 工具
概要
码文件 [选项[源文件 [- 额外文件]] 码 DOC [选项[源文件 [-
额外文件]]
商品描述
码(1) 是 Ruby 编程语言的可扩展文档生成工具。
它使用户能够生成一致的、可用的文档，这些文档可以导出到
非常容易地支持多种格式，并且还支持扩展自定义 Ruby 结构，例如
作为自定义类级别定义。
院子, 同义词 码 DOC 从列表中生成文档 源文件。 如果
此列表被省略，使用“{lib,app}/**/*.rb ext/**/*.c”。
可以通过添加一个选项来指定一组基本的选项 .yardopts 文件到您的基本路径
包含所有由空格分隔的额外选项。
配置
一般用途总体评估 可选项
-b, - D b 文件
使用指定的 .yardoc db 加载或保存到（默认为 .yardoc）
--[NO-]单数据库
代码对象是否应存储到单个数据库文件（高级）
-n, --无输出
只生成 .yardoc 数据库，没有文档。
-c, --使用缓存 [文件]
使用缓存的 .yardoc db 生成文档（默认为无缓存）
--无缓存
在解析源之前清除 .yardoc db。
--[NO-]码数 [文件]
如果参数应该从 FILE 中读取（默认为 yes，FILE 默认为 .yardopts）
--[NO-]文件
如果参数应该从 .document 文件中读取（默认为是）
--不保存
不要将解析的数据保存到 yardoc db
- 排除 REGEXP
如果匹配路径匹配（regexp），则忽略文件
输出 选项
--一个文件
将输出生成为单个文件
- 列表
列出要标准输出的对象（暗示 -n)
--不公开
不要显示公共方法。 （默认显示公开）
--保护
显示受保护的方法。 （默认隐藏保护）
- 私人的
显示私有方法。 （默认隐藏私人）
--无私人
使用@private 标签隐藏对象
--[无-]api API
为给定的 API（定义正确 @api 标签的对象）生成文档。
If --无 API 给出，显示没有@api 标签的对象。
--嵌入混合
将 mixin 方法嵌入到类文档中
--嵌入混合 [模块]
将特定模块中的 mixin 方法嵌入到类文档中
--无高亮
不要在输出中突出显示代码块。
--默认返回 型
如果方法没有返回类型，则显示。 （默认为“对象”）
--隐藏无效返回
隐藏指定为“void”的返回类型。 （默认显示）
- 询问 QUERY
只显示匹配特定查询的对象
- 标题 题目
为 HTML 文档添加特定标题
-r, --自述文件, - 主要的 文件
用作文档标题页的自述文件。
--文件 文件1,文件2，...
要包含的任何额外的逗号分隔的静态文件（例如，常见问题解答）
- 资产 从[:TO]
生成后复制到输出目录的文件或目录
-o, --输出目录 PATH
输出目录。 （默认为 ./doc）
-m, --标记 标记
文档中使用的标记样式，如textile、markdown 或rdoc（默认为rdoc）。
-M 加价供应商
覆盖用于处理标记的库
--标记提供者
格式化（指定 gem 名称）
--字符集 ENC
解析文件时使用的字符集（默认为系统区域设置）
-t, - 模板 版型
要使用的模板。 （默认为“默认”）
-p, --模板路径 PATH
在其中查找模板的模板路径。（与 -t 一起使用）。
-f, - 格式 FORMAT
模板的输出格式（默认为 html）。
--无统计
不要打印统计信息
--区域设置 本地
生成文档的语言环境（默认为 en）。
--po 目录 DIR
包含 .po 文件的目录（默认为 #{YARD::Registry.po_dir}）。
标签 opţiuni:
(行李牌:题目 好像： '超载:超载 付款方式')
- 标签 行李牌:题目
注册一个新的自由格式元数据 @tag
--类型标签 行李牌:题目
带有可选类型字段的标记
--类型名称标签 行李牌:题目
带有可选类型和名称字段的标签
- 名称标签 行李牌:题目
带有名称字段的标签
--标题标签 行李牌:题目
以第一行作为标题字段的标记
--隐藏标签 行李牌
从模板中隐藏先前定义的标签
--传递标签 行李牌
将标签标记为可传递的
--非传递标签 行李牌
将标签标记为不可传递
其他 opţiuni:
-e, - 加载 文件
在运行命令之前加载的 Ruby 脚本。
- 插入 PLUGIN
加载 YARD 插件（带有 `yard-' 前缀的 gem）
- 遗产
使用旧式 Ruby 解析器和处理程序。 在 1.8.x 中始终开启。
- 安全的
为此实例启用安全模式
-q, - 安静的
不显示警告。
--详细
显示更多信息。
-调试
显示调试信息。
--回溯
显示堆栈跟踪
-v, - 版
显示版本。
-h, - 帮帮我
显示此帮助。
示例
院子 -o “文档/” - “常见问题” “许可证”
上面的示例将“lib/**/*.rb”中文件的文档输出到“documentation/”
包括额外的文件“FAQ”和“LICENSE”。
使用 onworks.net 服务在线使用 yardoc
