问题标签 [yard]

我将 Ruby on Rails 3.1.0 和YARD 0.7.4 gem 用于文档目的。我想从另一个参数中引用一个参数（@param标签）。也就是说，我有：

可能吗？如果是这样，我该怎么做？

我正在使用 Rails 3.1.0 并且我已经实现了一个工作插件。和它应该做的一样，它的相关文件位于ROOT_APP/vendor/plugins/my_plugin目录中。

现在，我正在使用YARD 0.7.4 gem，我想记录那个插件。无论如何，当我运行yardoc（或yard doc）命令时，似乎没有考虑我的插件，因此不会生成相关文档（仅生成与“主”应用程序相关的文档）。

如何生成与我的插件相关的文档？

我的第一个问题是我发现这个--private开关不起作用yard server，那么如何让它工作呢？

其次，我注意到--privateswitch适用于yard doc，如果我选择使用yard doc生成doc文件而不是使用yard server，如何使渲染文档具有框架（侧栏）

我想<label>在 Yard 生成的 ruby​​ 类文档中包含一些 HTML 元素名称，例如 。但它不起作用。例如，句子

由 Yard 处理后变为

该<label>元素实际上是通过 Yard 逐字传递，使其作为原始 HTML 传递给浏览器。

我尝试<label>改用，但它被转义了，所以我最终得到<label>了结果文档。

谢谢！

YARD是为您的整个应用程序生成出色文档的宝石。

但是，我希望生成支持 XML 和 JSON 的 API 调用文档......同时包括指向对象描述及其参数等的链接。有没有办法做到这一点？

或者可能是院子里的一些秘密命令只生成 API 文档？

YARD 允许我指定方法参数和返回值的类型。因为我真的很喜欢回避类型，所以很高兴看到 YARD 还支持通过指定它们必须支持的方法来定义类型。

正如你在这里看到的，像这样的表达式

我希望能够为我的参数指定一个对象需要同时支持#first_method 和#second_method。有没有办法指定这个？

我将 Ruby on Rails 3.1.0 和YARD 0.7.4 gem 用于文档目的。除了此处README生成的文档顶部的文件之外，我还想添加更多文件（请参阅“文件列表”部分下链接页面顶部的、、、、 ...选项卡）。READMEWhat's New?Getting Started GuideArchitecture Overview

也就是说，默认情况下，YARD gem 似乎只生成与README我的 RoR 应用程序的 ROOT 目录中存在的文件相关的文档。我想记录其他文件，并为每个文件在文档顶部添加一个选项卡（如先前链接页面中所做的那样）。

可能吗？如果是这样，我该怎么做？此外，我是否应该创建一个新目录（在我的 RoR 应用程序的根目录中），其中包含用于文档目的的“自定义”文件？

我将 Ruby on Rails 3.1.0 和YARD 0.7.4 gem 用于文档目的。我实现了一个工作插件（在ROOT_APP/vendor/plugins/<plugin_name>目录中），我想记录那个插件。

注意：当我yard doc从应用程序的根目录运行终端命令以生成文档文件时，YARD gem 不会生成与我的插件相关的文档（所有其他文档文件都已正确生成）。

那么，是否可以记录插件？如果是这样，我该怎么做？

如果我用 YARD 记录我的代码，并使用例如@overload标签，然后其他人安装我的 gem 并使用 RDoc 生成文档，结果会不会很混乱？

有什么好的方法可以解决这个问题吗？

我真的需要一个不错的 Javascript 文档生成器，用于我正在开发的即将推出的 Javascript 库。显然，我需要我的图书馆的文档以便人们理解它。我在寻找一个好的文档库时遇到了很多麻烦，我查看了许多不同的项目，但它们不是我需要的。

是否有任何好的 Javascript 文档生成器可以在 Javascript 中创建Rubydoc.info或 YARD 样式文档？谢谢。