问题标签 [yard]

我是doxygen的忠实粉丝，多年来我一直使用各种语言。特别是，我很欣赏它类似于 wiki 的能力，可以包含图像并运行 Graphviz 点生成器，以从内联 DOT 代码或外部文件中获得任意内联图。

RDoc具有使用 Graphviz 生成类图的图表支持，但我看不到任何包含任意图像或图表的方法。它似乎也不支持建立像氧气这样的任意页面。

是否有任何工具可以为 Ruby 提供这些 Doxygen 风格的功能？

我浏览了 Ruby Toolbox工具列表，它们似乎都是 RDoc 的变体。

目前对我来说最可能的解决方案似乎是扩展 Yard。

我正在尝试在我的 YARD 文档中创建一些链接。我可以得到一个 HTTP 链接：

呈现为

但是一个电子邮件链接：

给我一个警告：

并呈现为

我已经尝试了链接的常规 RDoc 语法：

但 YARD 似乎忽略了这一点。有谁知道更可靠的语法？

我非常喜欢使用 YARD：

http://www.ootl.org/yard/

http://code.google.com/p/yardparser/

http://www.codeproject.com/KB/recipes/yard-tokenizer.aspx

我能够构建功能齐全的计算器。我正在评估 YARD 来做 PHP 解析器。请就 PEG 语法和解析器生成器的限制提出建议。非常感谢你！

我在我的 Rails 项目中使用YARD，想知道如何在 Rails 模型上记录继承/运行时方法？例如记录模型first_name上某个属性的存在。User

我在多个位置安装了几个 gem。

生成/重新生成的硬/简单方法是什么：

• 所有这些已安装的 gem 的 rdoc，一次？
• 所有这些已安装的 gem 的 yardoc 一次？

如果我错了，请纠正我，YARD与RDoc不一样吗？

它不是基于 RDoc 而是完全重写？

因此，如果我使用 YARD，我不必为 RDoc 烦恼，对吗？

我目前正在为我的 ruby​​ 软件文档从 rdoc 切换到 yard。

在我的文档中，我经常从评论中引用一些类/模块，例如：

Rdoc 正确地创建了指向 Mysoft::Mypackage::Utility::Logger 类文档页面的链接，而 yard 忽略了标记并将类名视为简单字符串。

我知道 yard 有 @see 标签，但是这将在文档中创建一个单独的“See Also”部分，而我需要在我的描述文本中引用类/模块。

我肯定遗漏了一些东西，但是如果您有任何关于如何使用 yard 完成此操作的示例，我将不胜感激。

感谢您的建议，

dl

我刚刚开始使用 Yard 来生成我的文档，虽然它对我的模型和控制器非常有用，但我似乎无法让它为视图生成任何东西

我尝试了各种不同的方法来让它工作。目前我已经设置了一个 rake 任务来生成看起来像这样的文档

我相信，最后一条路径应该让它包含我的观点，但是当我查看文档时，根本没有提到任何这些文件。任何想法为什么？

干杯

RDoc 具有 :include: 标记（参见本页底部），它将接收任意文本文件和格式，就好像它在包含开始的任何地方缩进一样。这是为文档示例提取源代码的好方法。

Yard是否有类似的标签或功能？

我正在编写一个中等大小的 Sinatra 应用程序，我将其分解为扩展，放置在 ./lib/extensions/ 中。我想记录每条路线，但 Yard::Sinatra 只记录主 application.rb 文件中定义的路线。我可以配置 Yard::Sinatra 来做某事还是我必须编写自己的插件？