问题标签 [yard]

我有一个典型的 OO 模式：一个基本抽象类（定义抽象方法）和几个以特定于类的方式实现这些抽象方法的类。

我习惯于在抽象方法中只编写一次文档，然后它会自动传播到几个具体的类（至少它在 Javadoc、Scaladoc、Doxygen 中的工作方式如下），即我不需要重复相同的描述在所有具体的类中。

但是，我找不到如何在 YARD 中进行这种传播。我试过了，例如：

我得到什么：

• 代码按预期工作 - 即在抽象类中调用 throws AbstractMethodException，在具体类中完成工作
• 在 YARD 中，AbstractClass明确定义为抽象，ConcreteClass是正常的
• 方法描述和返回类型在AbstractClass
• 据说方法AbstractMethodException投入AbstractClass
• 方法根本没有描述和通用Object返回类型ConcreteClass，在基类中没有一个抽象方法存在的通知。

我期望得到的：

• 方法的描述和返回类型被继承（即复制）到ConcreteClassfrom info atAbstractClass
• 理想情况下，此方法在描述的“继承”或“实现”部分中指定，并带有一些来自toConcreteClass的参考链接。ConcreteClass#do_somethingAbstractMethod#do_something

有可能这样做吗？

我有兴趣记录我的代码，其中大部分是我不创建新类的脚本。

从阅读YARD文档并尝试实际实现一些 YARD 文档，您似乎在定义的类中声明了您的 YARD 标签。当我创建一个类或向一个类添加新方法时，我已经成功地使用了 YARD，如下面的示例代码所示，我还能够使用 YARD 标签（如@author和）记录简单的事情@example。

我的问题是：

1. 有没有办法在不定义类的情况下使用 YARD 标签来记录代码（尤其是方法）？
2. 如果没有，除了在我的代码中添加大量注释之外，还有哪些解决方案？

有一个等价于 RDoc 部分的 With YARD ?

见http://www.ruby-doc.org/stdlib-1.9.3/libdoc/rdoc/rdoc/RDoc/Context/Section.html

我想构建分类 API，部分可能是实现它的好方法。

好的，我有一个任务，我必须从 ruby​​ 文件中提取方法和注释并将它们存储在数据库中作为参考

在此之前，我设法使用这段代码来实现相同的目标

然后在一个类中使用这样的东西

但事实上我必须为此编写一些代码，而且它们也不是实际的评论

我可以用 YARD 实现同样的目标吗

我有一些看起来像这样的 Ruby 代码：

花括号需要成为字符串的一部分。此行已注释掉我想保留在那里的代码。我还使用 YARD 来记录代码，所以当我运行yard doc它时（自然地）会抛出一个关于无法“真正”链接的警告。

有没有办法告诉 YARD 忽略注释掉的代码？

我正在使用yard为一些 Ruby 类生成文档。

我们可以记录一些可以通过如下方法引发的错误：

这是一个好方法吗？还有更好的吗？

我在一个类中创建了两个 attr_writer，我们称它们foo为bar.

YARD 不会呈现foowriter 文档。我认为那是因为我手动创建了读者。

有没有办法解决这个问题？

注意：我也尝试过@!attribute，但结果相同。

当我在 activeadmin 中添加一个新的索引页面时，我编写了如下代码：

事实上，activeadmin 已经创建了一些视图和控制器，我想在 yard 服务器中显示一些文档信息，但是 yarddoc 忽略了这个文件。

我应该怎么办 ？

在生成我的项目文档时，我收到了几个警告，因为 YARD 无法解析一些外部类扩展

问题的根源是一个无法解析的类扩展。我知道我可以运行yard -q来禁止所有警告，但我宁愿禁止单个扩展而不是所有内容。

据我在帮助中看到的，我可以--exclude但现在，有问题的类是外部宝石的一部分。我也试过@!parse没有成功

确切的问题是：我如何指示gem使用 Yard 生成我的文档。旧的使用#has_rdoc方式不再起作用。我找不到在较新的 GemSpec 版本中使用元数据的方法。我更喜欢使用 Yard 而不是 TomDoc，但 Yard 目前在安装例程中表现不佳。