在栏杆上的适当红宝石标签在红宝石矿中插值
想要在Ruby Mine中正确设置院子，任何建议都将不胜感激。 class Entity < ApplicationRecord belongs_to :user end # @param user [User] def authori…
院子如何记录@return类型的方法，以返回固定大小数组的方法？
我有以下方法： def foo [true_or_false, some_integer] end 它始终返回2个数组，其中第一个元素是布尔值，第二个元素是整数。 如何使用 @return meta…
YARD 和 RDoc 兼容性
如果我用 YARD 记录我的代码，并使用例如 @overload 标签，而其他人安装我的 gem 并使用 RDoc 生成文档，结果会不会很混乱？ 有没有好的办法来处理这…
如何记录除“README”文件之外的更多文件？
我正在使用 Ruby on Rails 3.1.0 和 YARD 0.7.4用于文档目的的 gem。我想在生成的文档顶部添加除 README 文件之外的更多文件 此处（请参阅自述文件、…
Ruby on Rails 的 XML API gem？
YARD 是一个为整个应用程序生成精彩文档的宝石。 但是，我希望为 API 调用生成文档，支持 XML 和 JSON...同时包含对象及其参数描述的链接等。有没有办…
如何使用YARD服务器显示私有方法？
我的第一个问题是我发现 --private 开关不适用于 yard server，那么如何让它工作呢？ 其次，我注意到 --private 开关适用于 yard doc，如果我选择使用…
如何以正确的方式声明和显示与常量值相关的文档？
我正在使用 Ruby on Rails 3.1.0，并尝试使用 YARD 0.7.4。我想记录常量值，因此在我的类中我声明了这一点： # [Fixnum] Test constant documentation…
使用 Ruby 的 Yard 文档工具，我可以将 Yard 配置为*不*按字母顺序放置方法吗？
我正在开发一个 Ruby 编程教程，我想用 Yard 记录该教程。默认情况下，Yard 将模块/类中的所有方法按字母顺序排列。但是，由于本教程中每个模块中的方…
YARD：记录包含的模块添加的类方法
我正在使用 YARD 为我的 ruby gem 编写文档。在我的 gem 中，我有一些代码遵循这种常见的 ruby 模式，其中模块包含在类中，并且该模块不仅添…
使用 YARD 进行 Ruby 文档的内部评论？
我正在将我维护的 rubygem 从 RDoc 切换到 YARD 文档。但是，代码中有一些关键注释只需要保留在代码中，而不应该出现在文档中。例如： ## # SomeC…
所有带有yard的离线Ruby文档
如果我想查看有关 gem 的文档，我可以这样做： yard server --gems How can I see the Documentation of Ruby's standard library?…
生成文档时宏不能一致地工作
我在 YARD 文档工具中使用宏，在某些文件上它们可以工作，有些则不能。 例如，我在我的源文件之一中定义了一个宏。 # @macro [new] my_macro # @param…
更改yardocserialized_path
现在 Yardoc 将生成如下文档： doc/ModuleName.html、doc/ModuleName/ClassName.html 和 doc/ModuleName/ClassName/method_name.html 我想知道如何调…
