问题标签 [rdoc]

我想将我现有的评论格式化为“RDoc 评论”，以便可以使用ri.

开始使用 RDoc 的推荐资源有哪些？

好的，我正在尝试为回形针生成 rDoc，但是 rake 任务在到达另一个插件之前就被另一个插件阻塞了，所以这是不可能的：

我可以去修复损坏的插件，但我又忙又懒，所以我只想为回形针生成文档。有没有办法做到这一点？

我正在使用一些元编程在 ruby​​ 中生成一堆方法，如下所示：

我知道我可以通过rdoc'-A mood' 让它将我的情绪生成代码识别为属性，这很方便，从那时起它们至少会被识别。

但是，它们实际上更像是常规方法而不是属性，所以当我使用ri. 我没有任何常规属性，所以有什么简单的方法可以将本节的标题更改为“Moods：”或类似的东西，所以我的用户至少有足够的好奇心来输入ri EmotionalObject#happy.

在 RDoc 中，有没有办法显示不断的评论？我想在我的一个项目中评论一个常量，但意识到它们没有出现在 RDoc 输出中。我检查了可能对其常量有评论的文档，但从未看到任何（http://www.ruby-doc.org/core/classes/Math.html）。

他们可能会在常量旁边显示实现，因为假设这是不言自明的，但似乎评论也会有所帮助。

所以，我最近一直在写一堆 ruby​​ gem，我觉得方便的一件事是在rdoc我的库的 -generated 文档和OptionParser-generated--help使用的部分中包含当前版本（如 gemspec 中指定）通过我的脚本（我通过 gem 分发）。无论如何，我都可以让我的用户轻松找出他们当前正在使用的库/脚本版本。

lib/有什么方法可以从我的or目录中的 ruby​​ 文件访问我在 gemspec 中指定的版本bin/？这样，我不必一次在多个地方更新它 - 只需在我的 gemspec 中。

目前我手动生成我的 gemspecs，我还没有跳上 Rake 火车。如果我不能只用 ruby​​gems 给我的东西直接做我想做的事，rake 或其他工具会允许我这样做吗？

我喜欢通过 help2man 和 txt2man 使用“--help”输出生成手册页。Ruby 的 RDoc 系统非常方便，但我似乎无法完全按照我想要的方式配置 RDoc::usage。这是一个示例脚本：

脚本的输出如下所示：

但我真的很想为我的使用输出抑制“名称”和“概要”标题，但仍将它们标记为输出到手册页的部分。

使用 ':section:' 标记适用于 RDoc::Rdoc，但不适用于 RDoc::usage。是否有一种明显的方法可以在不打印标题的情况下标记 usage.rb 部分？

Rubyinside 提到了一篇关于如何通过不安装 RI 或 RDoc 来加速 gem 安装的博客文章。

是否可以安装一个 gem，然后在以后安装文档，这样您就可以在闲暇时匆忙破解和 RTFM？

我想用Hanna模板生成Ruby 文档。

怎么做？或者如果有的话我在哪里可以下载？

使用

rdoc -o ~/doc --inline-source --line-numbers --format=html --template=hanna

给我缺少方法的文档。似乎它不会生成用 C 编写的方法。

我最近通过 Ruby gems 安装了 RDoc 版本（2.4.3）来替换 Mac OS X（版本 1.0.1）附带的版本。不幸的是，当我在命令行中调用 run "rdoc" 时，我仍然只能使用 RDoc 1.0.1。rdoc -v 返回：

我尝试修改 $PATH 变量以将第一个条目指向 RDoc 2.4.3 文件夹，但没有运气。我在网上也找不到任何关于这个的东西，所以我想我会在这里问。

干杯!

更新：

运行“ gem list -d --version 1.0.1 rdoc”返回：

因此，肯定是 Mac OSX 版本的 RDoc 干扰了 Gems 版本。

更新 2：

我发现，使用：

旧版本的 RDoc 在 /opt/local/bin 中。我删除它并将我的 gems 目录添加到我的 $PATH

我现在有了最新 RDoc 的新工作副本！

根据这篇文章，RDoc::usage 目前在 ruby​​ 1.9 中不可用。有没有好的替代品？

我很想听听标准安装中可用的内容以及 gems 中可用的内容。