2012-02-21 34 views
1

我想要在Ruby代码中记录一些方法,其中方法的签名是(* args)。实际的方法调用可以包含两种或三种不同的形式。我想记录这些不同的表单,以便它们出现在RDoc中。Rdoc:如何为带有(* args)签名的方法记录不同的表单?

E.g.

def doit(*args) 

所得的RDoc必须证明:

度特(时间,地点)=>布尔,DOIT(什么)=>数组

而不是实际的方法签名。

回答

0

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

我看到很多建议使用YARD代替,它有一个标记@overload,它符合相同的目的。

相关问题