问题标签 [yard]

我正在使用YARD为我正在处理的几个项目生成文档。一方面，我正在共同开发一个gem，它承载了许多将被其他项目使用的冗余和共享资源。

我想要的是从第一个项目到 gem 中的类或方法的引用，以显示在主项目的文档中。例如

宝石

项目

我希望 SpecialWidget 的文档能够生成到 Widget#spin 方法的实际链接。

这可以做到吗？

对于基本的 Ruby 方法，我将为以下格式的参数提供 YARD 样式的文档。

在 Ruby 2.0 中，现在可以使用关键字参数。但是，我不确定如何根据 YARD 文档来解决这个问题。

在第二种情况下，exact_match我将如何记录？results_per_page我应该继续使用@param关键字，还是有更好的方法？

我有一个带有可变数量参数的函数，如下所示：

所有 args 都是相同的类型 ( Symbol)，所以现在我记录这个函数，就像只有一个参数一样，说它可以接受多个参数，例如：

有没有内置的方法来处理这种情况？

我有一个像这样记录的函数：

产生这个结果：

我的问题是文档说该函数需要一个块并且它返回一个值。实际上，该块是可选的。如果提供了块，则会为每个结果调用它，并且该函数不返回任何内容 ( nil)。如果未提供任何块，则结果以数组形式返回。

如何在文档中说明这一点？有推荐的方法吗？

除了指定它输出的内容之外，我对这个函数没有任何用处。如果 Yard 没有找到描述，它会使用 的内容@return。有什么办法可以防止这种情况发生吗？我想避免像您在下面的示例中看到的那样愚蠢的重复。

我正在尝试将我的应用程序从 rails 3.2.18 升级到 rails 4.0，但我遇到了 rake 问题。

我有一个自定义 doc.rake 任务，它覆盖了 doc:app，其中包含以下代码，在 rails 3 上运行良好：

由于升级 rails，我尝试运行的任何 rake 任务都会失败并出现错误：

我真的不知道为什么会这样。我找不到对删除默认 doc:app 任务的 rails 4 的任何引用，因此它应该仍然存在供我覆盖。

如果找不到用户，我有一个返回用户或 nil 的函数。它看起来像这样：

我的问题是，如果找不到它，我如何记录它返回用户或 nil？

如果我有一个返回这个的函数：

我正在这样记录它：

我想知道是否有更好的方法来记录返回的 JSON 的外观。

要求pry我的 RSpecspec_helper.rb并运行我的规范会给我一堆警告。我该如何摆脱这些？

在查看Yard 文档和示例时，我发现了一些以感叹号为前缀的标签。

我找到了带和不带感叹号的工作示例，但我无法发现差异，那么当@!some-tag使用 代替 时会发生什么变化@some-tag？

例如，此代码为两者生成相同的attr文档attr2

另一方面，在某些 示例中，感叹号的重要性带有下划线，因此它应该做一些事情，但我找不到任何有关其用法的文档。

@!method 示例

Rails 模型中的这两个注释都会生成新方法

场输出：