RDoc 为 Ruby 项目生成 HTML 和在线文档。
此命令会为当前目录及其下所有 Ruby 和 C 源文件生成文档。 这些文档将存储在以子目录 doc 为起点的文档树中。 您可以让索引页面包含主要文件的文档，以便为读者提供更有用的信息。 在我们的例子中，可以输入
RDoc 使用文件扩展名来确定如何处理每个文件。 以 .rb 和 .rbw 结尾的文件被假定为 Ruby 代码。 以 .c 结尾的文件被解析为 C 代码。 以 .rbs 结尾的文件被解析为 RBS 签名文件。 其他所有文件被假定包含标记语言的标记 (带有或不带有前缀 # 的注释标记)。 如果向 RDoc 提供了目录名,则会递归扫描 C、Ruby 和 RBS 源文件。
要使用 rake 生成文档,请参阅 RDoc::Task。
暂无开放 Issues，或尚未同步最近议题。