问题标签 [rdoc]

你可以像这样使用八爪鱼：

但我在 API 文档http://rdoc.info/github/pengwynn/octopussy/master/Octopussy中找不到“用户”方法

根据文档，模块由 SingleForwardable 扩展。

该模块必须包含“用户”方法，但我找不到该模块。

这是为什么？

如果我错了，请纠正我，YARD与RDoc不一样吗？

它不是基于 RDoc 而是完全重写？

因此，如果我使用 YARD，我不必为 RDoc 烦恼，对吗？

我目前正在为我的 ruby​​ 软件文档从 rdoc 切换到 yard。

在我的文档中，我经常从评论中引用一些类/模块，例如：

Rdoc 正确地创建了指向 Mysoft::Mypackage::Utility::Logger 类文档页面的链接，而 yard 忽略了标记并将类名视为简单字符串。

我知道 yard 有 @see 标签，但是这将在文档中创建一个单独的“See Also”部分，而我需要在我的描述文本中引用类/模块。

我肯定遗漏了一些东西，但是如果您有任何关于如何使用 yard 完成此操作的示例，我将不胜感激。

感谢您的建议，

dl

在 Ruby 中，如果您运行该命令gem server，它将为您提供一个包含您机器上安装的所有 gem 的文档网页。可以为您的本地文档做类似的事情，以便您所有的本地 rdoc 文档都在一个易于访问的地方吗？任何建议将不胜感激，谢谢。

我正在使用的课程中有这个方法

我希望在文档中参数显示为def binary_search(array, key)而不是binary_search(a,x). 我尝试使用文档修饰符# :binary_search: array, key但没有成功。我知道这一点，但如果有人知道如何使文档中的参数与实际源代码中的参数不同，你能告诉我吗？谢谢。

使用 Darkfish RDoc 生成器生成 RDoc 文档时，在方法Click to toggle source旁边，每个方法旁边都有一个按钮。当我生成我的文档时它对我不起作用，那么你如何让该功能工作，你是否必须在你的 RDoc 源中添加一个关键字或其他东西？

我在开发新宝石时使用珠宝商宝石。作为骨架的一部分，它设置了一组与 RDoc 相关的 rake 任务——主要的是rake rdoc. 据我从 Rakefile 中得知，此任务使用该rake/rdoctask库从我的 RDoc 注释生成 HTML 文档。

它智能地尝试引用我的 RDoc 注释中的类和方法。但是因为我有一个方法叫做user，所以每次我写userRDoc 生成器时都认为我引用了这个方法。根据RDoc 手册（在“记录源代码”的最后），可以通过在单词前加上反斜杠 (\) 来禁用此功能 - 例如\user。

但就我而言，这不起作用。它只是在完成的 HTML 文档中输出反斜杠，并且仍然使用该单词作为交叉引用。

知道如何让它发挥作用吗？

我正在为正确的 RDoc 语法寻找一个好的、可靠的参考。建议？我似乎找不到任何清楚显示的内容：

1. 如何记录类方法及其参数
2. 如何记录类或类方法的作用。

我正在用 rdoc 记录一个 Ruby 项目，我发现了 darkfish rdoc 格式化程序。我真的很喜欢它，但:call-seq:标签不再有效。相反，它将文字字符串:call-seq:放入文档中，然后将调用序列本身格式化为代码块。我不想只从我的代码中取出所有 :call-seq: 块，因为我的大部分文档都需要引用:call-seq:块中给出的实例名称和参数名称。有没有其他人有这个问题？我该怎么办，有没有解决方法？我很确定:call-seq:当我使用默认格式化程序时，标记之前工作，但我无法确定，因为我无法弄清楚如何返回生成原始格式（调用 rdoc 时除了文件之外没有参数现在会生成 darkfish 输出，即使我删除了 doc 文件夹！）有谁知道如何解决这个问题？

我刚刚开始记录一个 Rails 应用程序。我知道这实际上是由 rdoc 完成的，所以我遵循了一些关于语法等的 rdoc 指南，但是当我试图描述模型的属性、验证和模型之间的关系时，我被卡住了，主要是因为这些东西是 ActiveRecord 的一部分。所以我想知道是否有一些关于如何记录 Rails 应用程序的指南或良好实践，或者我是否遗漏了什么？

我知道我可以将所有这些都放在类描述中，但我想知道是否有一种与声明本身更紧密相关的方法（has_many、validates_presence_of 等）以及属性呢？