问题标签 [yard]

我寻找了 gem 附带的模板（我只能找到默认的 HTML 输出器），我在帮助和在线文档中搜索了一个将重定向到 STDOUT 的开关。我找不到任何关于如何解决这个问题的信息。

有没有一种简单的方法可以做到这一点（也许是一个 shell 命令？）还是我已经浏览了源代码？

Yard 有一个标签@!method来描述动态创建的实例方法的文档。类方法是否有类似的标签？

我正在运行“yard server -g”，但它只为 axlsx 生成目录。

当我点击一个类时，我得到：

知道为什么吗？（Fwiw，其他宝石在 Yard 服务器中运行良好）

我在运行 Yard 然后单击文件链接时得到了这个：

有什么建议么？

我在我的.yardopts文件中创建了一些自定义标签，如下所示：

当我在网络浏览器中查看它们时，它们显示得非常好，但是当我尝试查看一个类时，yri我没有看到我的自定义标签正在显示。

比如这个类

yri在我运行时显示为这样yri Boring#index

有没有办法配置yri显示我的自定义标签？

I have a DSL method which adds a constant (it's legacy code so don't hate). This isn't the exact code, but it's descriptive enough.

I am attempting to document the constants AWESOME and LAME using Yard. I would expected there to be a @!constant tag, but there is not.

Can anyone help with this?

我使用 YARD 记录了一些 Ruby 代码，但我无法将我为顶级名称空间中的某些方法创建的 YARD 文档显示在 yardoc 的 HTML 输出中。

我的文档看起来与 lib/yard/globals.rb 中的 YARD gem 自己的文档基本相同，只是添加了一个@api标签。我确实尝试删除它，并在yardoc没有--api参数的情况下运行，但这无济于事。

这是一个例子：

当我运行yardoc生成 HTML 文档时，起初一切看起来都很好：

生成的 HTML 不包含我的任何文档。它只包含一个带有pip-negotiateAPI 标签的方法列表。您可以在这里亲自查看：

http://btw23.de/tmp/pip-negotiate/api/method_list.html

相反，我期望的是更像 YARD 自己的关于顶级方法的文档：

http://rubydoc.info/gems/yard/toplevel

我的祈求中是否缺少任何特殊的魔法yardoc？

我的 yardoc 版本是 0.8.6.2，运行在 Ruby 1.8.7 (2012-06-29 patchlevel 370) [x86_64-linux]

我正在使用 Yard 生成文档，但我找不到任何关于 ruby​​ on rails 项目的示例文档。我发现只有简短的入门教程，以及ruby​​doc.info上的一些 github 项目，但它们根本没有记录。请有人告诉我如何正确记录控制器（带有动作），模型，rails项目的路线

例如我有这样的控制器：

和一个用户模型：

我正在使用 Yard 生成文档，但即使我运行了yardoc --private，它也没有在源代码中显示私有方法的文档。

怎么了？

我有以下方法，我想使用YARDoc.

dangerous这会生成以粗体显示的HTML 。因为我必须解析这个输出，所以我想要一个自定义 HTML 标记。换句话说，我想让它在下面的代码注释被解析时YARDoc，这个词dangerous被<div class="custom"></div>标签包围，而不是<b><\b>标签，这使得用 Nokogiri 解析更容易。并不是说目前无法使用 Nokogiri 进行解析，它只是有点尴尬并且容易受到 YARD 代码更改的影响。

YARD 中是否有任何功能可以让我做到这一点？我查看了创建自定义模板，但这似乎更多地涉及解析代码。然后我检查了创建自定义降价模板，但我没有看到这可以或应该如何完成。我开始觉得我在找错树了，我会很感激谷歌关键词给我的。

为什么我首先要解析 HTML：
正如我在前面的问题中所描述的，我正在尝试定义一个接口而不必复制代码。在此示例中，我希望服务器“调用”危险的方法与不危险的方法不同。