ruby - 如何在 Yard 中记录生成的类?

标签 ruby rdoc yard

我有一个从工厂函数创建的类,如下所示:

Cake = MyProject.Struct(:type, :price)

在 Yard 中,它只是与我的常量一起显示:

Cake =

        Struct(:type, :price)

I want it to show up in the "Classes: " list. After reading up on the docs, I was lead to believe that this would work:

# @!parse class Cake; end
Cake = MyProject.Struct(:type, :price)

但它确实没有任何改变。

是否可以让 Yard 将动态创建的类记录为类?

最佳答案

自问到这个问题已经有一段时间了,但在谷歌搜索自己的答案时,我被引导到这里,并想发布我的解决方案以防其他人在这里绊倒。

我发现这解决了问题:

class Cake < Struct.new(:type, :cake)
end

关于ruby - 如何在 Yard 中记录生成的类?,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/26801135/

相关文章:

ruby-on-rails - 限制对 Ruby on Rails API 的请求

ruby - 安装 RDoc 文档时出错 : incompatible encoding regexp match

ruby-on-rails - Ubuntu 10.10 上的 Rails 安装失败

ruby-on-rails-3 - 在 Mac OS X Lion 上安装 rails 3.1 时找不到文件 'lib'

ruby-on-rails - 如何使用 YARD 记录 Rake 任务?

rspec - Pry 给出了一堆警告

ruby - 有没有办法在 Ruby 中定义新文字?

mysql - 如何显示 "parent"公司以及给定位置的设施数量?

ruby-on-rails - 如何访问 Capistrano 中的服务器特定选项?

ruby-on-rails - 如何使用Yard记录Rails枚举类型