13得票1回答
码场相对链接到额外文件

我想使用Yard从我的README中链接到另一个额外的文件。 例如,我有以下行: ...详细说明请看[这里](contributing.md),了解如何做出贡献 我希望它能够链接到同一目录中的contributing.md文件。 我可以在我的.yardopts文件中包含额外的...

12得票1回答
如何使用YARD文档化"扩展"参数的最佳方法?

我有一个方法,应该可以接收任何类的1个或多个参数,类似于Array#push:def my_push(*objects) raise ArgumentError, 'Needs 1+ arguments' if objects.empty? objects.each do |obj| ...

12得票1回答
如何使用YARD文档记录返回空值的方法

我有一个像这样的方法def self.import(file_name, opts = {}) 我正在尝试使用YARD记录这个方法。然而,这是一个完全具有副作用的方法(我知道,我知道,副作用,呃!)。但对于使用此方法的用户来说,实际上没有任何类型的返回对象,但是YARD生成了这样的签名:+ (...

11得票2回答
如何记录 AngularJS + Ruby on Rails 应用程序?

我正在使用 yard 从 rdoc 文件为 Rails 应用生成文档。有 AngularJS 文档生成器,但如何将它们连接起来生成一个 AngularJS + Rails 应用的一致性文档呢?

11得票1回答
YARD:记录被包含模块添加的类方法。

我正在使用YARD为我的Ruby gem编写文档。 在我的gem中,我有一些代码遵循这种常见的Ruby模式,在其中一个模块被包含在类中,并且该模块不仅添加实例方法,还添加了类方法:module Moo def self.included(klass) klass.extend Cl...

10得票1回答
Yard文档和`define_method`

有没有办法在YardDoc中注释使用define_method定义的方法? 我尝试了这个:%w(one two three).each do |type| # The #{type} way # @return [String] the #{type} way define_me...

10得票2回答
如何在YARD中记录具有可变参数的函数?

我有一个函数接收可变数量的参数,就像这样: def myfun(*args) # ... end 所有参数都是相同类型(Symbol),因此我现在像只有一个参数一样记录该函数,表示它可以接受多个参数,例如: # this function doesn’t do anything #...

10得票2回答
YARD:如何创建到类方法的链接?

如何在YARD中创建到Ruby类方法的链接?这里是关于链接的yard文档。 在相同命名空间内链接到一个实例方法: {#my_instance_method} 这种方法很有效。然而,使用同样的方法来处理类方法无法编译,并需要进行修改: {#self.my_class_method} ...

9得票2回答
如何使用Yard来记录Rails中的枚举类型

我有一个类似于这样的ActiveRecord类: class User < ActiveRecord::Base # How do I document this? enum status [:registering, :active, :suspended, :delete...

9得票3回答
用Yardoc记录def_delegators

我有一个使用Forwardable模块中的def_delegators方法的类。我还没有找到一种方法来让Yardoc为其输出文档。我尝试使用宏,但是它不会输出这些特定方法的任何内容(文件中的其他内容都正常,没有错误),而且我有几个长度不同的def_delegators。 class A ...