问题标签 [yardoc]

在 Ruby 中，我会多次将代码段与以下内容分开，以便我可以快速扫描代码中的一段代码。

这不是为 yarddoc 记录的。

有谁知道如何将其排除在代码文档中？

我有一个 ruby​​ 项目，其中包含一个模块和一个在模块中定义的类：

• a.rb
• a/b.rb

文件 a.rb 包含：

文件 a/b.rb 包含：

当我运行yardoc **thenyard graph --full --dependencies | dot -T pdf -o doc/diagram.pdf时，生成的 pdf 包含 B 类，它在模块 A 之外。

但是，在 yardoc 生成的 HTML 文件中，类 B 正确地放置在模块 A 中。

如何配置 Yard 以便将 B 类放置在模块 A 内？

我在我的项目中使用 yard 作为文档，但我不想向用户展示我的源代码。有没有办法在院子里隐藏源代码。

有什么方法可以从 github 项目生成 Yard 文档。我们有几本带有 Yard 标签的食谱，准备好用 Yard 解析和生成文档。

有任何想法吗？

谢谢比斯瓦吉特

是否有可以从我们的 github 存储库中提取并生成和托管我们的 yard 文档的服务？

我的团队似乎从不查看我们的文档，因为他们必须在本地生成它们然后导航到它们。这也导致他们停止以 Yard 格式编写有用的文档。

类似于http://www.rubydoc.info/但能够拥有只有我的团队才能访问的私人文档。

我有一个看起来像这样的方法：

我希望这个方法的调用者能够传入一些可选参数。

我想编写 YARD 文档来支持这一点，如果我不使用关键字参数，我会使用@option 声明。

但是，YARD 自己的文档说：

注意：对于关键字参数，使用@param，而不是@option。

所以我尝试了：

那失败了，因为 YARD 只看到params我正在使用的关键字参数。确切的失败是：

于是我尝试使用@option替换为param关键字的语法：

这会导致不同的错误：

理想情况下，我想params用此方法的用户可以使用的 3 或 4 个选项来描述散列。有没有办法做到这一点？

我目前正在尝试使用 yardoc 记录我的 serverspec 测试。为此，我安装了 yard-serverspec-plugin ruby​​gem，它的工作还不错。

但我有一个问题。rubygem 以相同的方式处理“描述”和“上下文”，并且不会将其结构化。因此，很难为失败的 serverspec 测试找到正确的文档。

这些是我的 serverspec 测试：

这就是它的记录方式：

在这里你可以找到处理程序的代码：https ://github.com/rrreeeyyy/yard-serverspec-plugin/blob/master/lib/yard/serverspec/plugin/handler.rb

我的问题是，是否有人知道如何调整处理程序代码以在具有层次结构的 html 文档中仅获取 2 个对象？因为“操作系统名称和版本”对象真的没用。像这样的东西会很好：

提前致谢和问候

我们正在使用 Yardoc 为许多 gem 和我公司的应用程序创建 HTML 文档。我们还使用 Rubocop 来实现风格指南合规性。

我遇到的问题是我们必须启用/禁用一些方法指标和那些# rubocop:disable Metrics/AbcSize出现在我们文档中的注释（等）。是否有一个插件可以删除这些或一些我可以遵循的指南来创建我自己的？

我使用 YARD 为 ruby​​ 项目生成文档。该项目包含一个README.md文件，如下所示：

YARD 生成的文档包含这个自述文件，但它有一个小问题。文件的路径static/logo/mytool.png和LICENSE.txt错误。生成的index.html指向doc/static/logo/mytool.pngand doc/LICENSE.txt，所以当我点击它时链接被破坏了。

我试图将这些文件移动到doc文件夹，但 YARD 会生成这样的引用doc/doc/static/logo/mytool.png。注意双重doc参考。

我是 YARD 和红宝石的新手。处理这个问题的最佳实践是什么？YARD 可以将此文件复制到 doc 文件夹吗？

我有一个带有返回 lambda 的方法的对象：

我想用yardoc语法记录这个Book#mark_page方法。但是，我在本文档中找不到任何关于 lambdas 的信息。

直觉上，我会选择类似的东西：

由于yardoc.org/types将其解析为：

包含（页面）的 Proc

_{PS：不太确定documentation标签。如果不合适，请随意删除它...}