问题标签 [yard]

# -*- encoding : utf-8 -*-我的Rails 应用程序中每个 ruby​​ 文件的顶部都有魔术注释。问题是，它显示在我的 YARD 文档中每个类定义的概述部分中：

有没有办法可以省略它？

我在 RoR 工作了 2-3 年，但现在我重新开始工作了，我真的很喜欢这个bundle命令。但我有点不确定如何确保我的开发人员伙伴安装了所有不属于 Rails 应用程序的gem 。

例如，我们使用 YARD 来记录文档。YARD 与我们正在进行的 Rails 项目没有任何关系，所以我不确定是否应该将它添加到它的 Gemfile 中。另一方面，这是确保每个开发人员都自动安装它的唯一方法。

如果我将它添加到 Gemfile，我应该怎么做呢？在:development组中，所以它不会被加载用于生产？但严格来说，它也不应该在开发中加载，它只是简单地安装，以便手动使用。

那我应该怎么添加呢？谢谢各位，求帮助。

我刚刚开始使用 YARD 来记录我的 Rails 应用程序。我没有指定任何特定的标记处理程序，但我预计 `code` 会被转换为code，这似乎不会发生。这是正常行为吗？我是否必须添加一些额外的选项才能完成这项工作？谢谢你。

有没有办法告诉 Yard 不要弄乱我的 Rails 项目doc/文件夹？我希望它保存它的文件doc/yard/或类似的东西。可悲的是，我没有找到任何选择。

谢谢你的帮助。

我在他们的网站上的任何地方都找不到。

这是我所拥有的：

但是当我运行 yardoc 生成时，我得到了这个错误：

当我转到编写上述文档的 api 页面时，它只显示纯文本，而不是指向该对象页面的链接。

我怀疑，上述错误是因为它从未找到这个类：

（但如果我将其更改为 PageSection，则文档呈现得很好）。

也许它与我正在使用的yard-rest-plugin版本有关？我不确定

我已经得到了我认为是相当基本的 yard 宏用法，其中我有一个 Hash 结构，其中包含多个在多个函数之间共享的选项。我希望使用宏只是为了防止我不得不在整个地方复制这个结构，但它似乎不像那样工作。

我期望的工作是：

并正确记录 h1 和 h2。我想我已经发现至少 $1 不能像那样工作，而是从函数本身获取，但我可以调用这两个参数 h1 并在宏中用 h1 替换 $1 ，但我仍然没有得到我想要的.

http://rubydoc.info/docs/yard/file/docs/Tags.md#macro上的“定义简单宏”示例表明我可以做到这一点（请注意，我找到了带有 @!macro 的示例，有些没有但似乎都不起作用）。

我对院子不太了解，但这不起作用吗？我可以做一些类似的事情来实现我的结果吗？是否有调试功能可以解释这一点，因为庭院服务器控制台中没有出现错误？

谢谢

我正在使用RVM,Ruby v1.9.3-p125和Ruby on Rails v3.2.2. 在我的 Ubuntu 服务器上，我正在尝试安装remotipart v1.0.2gem，但出现以下错误：

这是什么意思？remotipartgem 是否正确安装？我该如何解决这个问题？

作为 git 提交工作流程的一部分，自动生成 ruby​​ 文档的最佳实践是什么？我们希望在提交合并到 master 时自动生成新文档。

我下载了 ruby​​ Twitter gem 源代码，并尝试使用 yard 生成文档，我通过gem install yard. 在 rakefile 中，我发现了以下内容，我假设它用于生成 Twitter gem 的文档：

我试图require yard在 irb 中然后运行YARD::Rake::YardocTask.new，但什么也没发生。

你能帮我走上正轨吗？

我想生成一些公开可用的文档，因此我希望删除 Yard 默认生成的输出的某些方面。我已经设法删除了源代码及其链接，但我也想删除：

• 类名。
• 继承信息。
• “定义于”信息。
• 如果可能的话，“班级名单”| “方法列表” | “文件列表”菜单。

我通过添加删除了源：

到路径 .yard_templates/no_source/default/method_details/setup.rb 并在生成时引用它。（感谢这个答案）

尽管维护人员尝试使用有关模板的文档很有帮助，但我只是不知道如何做到这一点。

我尝试查看输出并向后工作，并通过检查sections上面的代码，但我不知道如何确定 HTML 输出中的哪个部分由代码中的什么表示？

任何帮助或见解将不胜感激。

编辑：我找到了如何删除继承信息：