Rdoc:如何使用(* args)签名记录方法的不同表单?

时间:2012-02-21 08:01:20

标签: ruby rdoc

我想在我的Ruby代码中记录一些方法,其中方法具有(* args)的签名。实际的方法调用可以包括两种或三种不同的形式。我想记录这些不同的表格,以便它们出现在RDoc中。

E.g。

def doit(*args)

结果RDoc必须显示:

  

doit(时间,地点)=>布尔,doit(what)=>阵列

而不是实际的方法签名。

1 个答案:

答案 0 :(得分:0)

似乎call-seq:指令就是答案。

我看到很多使用YARD的建议,它有一个标记@overload,可以达到同样的目的。