YARD 和 RDoc 兼容性
如果我用 YARD 记录我的代码，并使用例如 @overload 标签，而其他人安装我的 gem 并使用 RDoc 生成文档，结果会不会很混乱？ 有没有好的办法来处理这…
为 Java 类/源代码构建 Ruby 文档
由于我最近开始使用 JRuby，更具体地说是使用 Ruby 代码构建 Java 应用程序，因此我开始使用 Java 库，例如 LWJGL 和 Slick。 我知道 JRuby 将 Java …
Rdoc：如何使用（*args）签名记录方法的不同形式？
我想在 Ruby 代码中记录一些方法，这些方法的签名为 (*args)。实际的方法调用可以包括两种或三种不同的形式。我想记录这些不同的表格，以便它们出现在…
什么文档软件正在使用 Ruby on Rails 3.1？
Closed. This question does not meet Stack Overflow guidelines. It is not currently accepting answers. 这个问题似乎与帮助中心中定义的范围内…
使用 YARD 进行 Ruby 文档的内部评论？
我正在将我维护的 rubygem 从 RDoc 切换到 YARD 文档。但是，代码中有一些关键注释只需要保留在代码中，而不应该出现在文档中。例如： ## # SomeC…
如何在 RDoc 中排除模块但包含该模块的类
运行 RDoc 对于某些空白模块没有意义。例如： class moduleName::className < ActiveRecord::Base def foo end def bar end end RDoc 生成报告： modu…
使用 ri 数组时，一无所知……Ruby
我有 Ubuntu 11.10 并使用 rvm 和 ruby 1.9.2。我完全按照这个安装 Ruby： http://blog.sudobits.com/2011/10/27/how-to-install-ruby-on-rails-i…
Rails：如何解决“rake/rdoctask”问题已弃用警告？
只是一个预警：我是一个 Rails 菜鸟。 当我运行： rake db:migrate 我收到此弃用警告： WARNING: 'require 'rake/rdoctask'' is deprecated. Please u…
自定义 RDoc::ClassModule#description
我正在尝试为 RDoc 编写一个新的生成器，但我无法弄清楚如何为 RDoc::ClassModule 对象自定义 description 输出。目前它看起来像这样： Gist API is..…
如何使用 RDoc 标记呈现逐字记录/代码/前置加号？
使用 RDoc 标记并使用 Yard 生成文档，我试图记录一些命令输出，其中包含一行： +----------------------------------+ ...但不知道如何实现这一点。…
没有要加载的文件——rdoc/task
当我运行时， rake db:create 我收到此错误 rake aborted! no such file to load -- rdoc/task (See full trace by running task with --trace) 这是 …
为 Rails 应用程序创建 Rdoc
我想为我的 Rails (2.3.8) 项目生成文档。当我尝试时， rake doc:rails rake doc:rerails 它为所有类创建文档，包括标准 ruby 类和供应商目录中的…
在 Rails 中添加模型范围的文档
我不确定这是否真的可行，但我试图通过在 app/models 文件中添加范围文档来使 Rails 应用程序的文档更加完整。我想要尝试做的是： # This is a descri…
