2012-02-21 63 views
1

我想要在Ruby代碼中記錄一些方法,其中方法的簽名是(* args)。實際的方法調用可以包含兩種或三種不同的形式。我想記錄這些不同的表單,以便它們出現在RDoc中。Rdoc:如何爲帶有(* args)簽名的方法記錄不同的表單?

E.g.

def doit(*args) 

所得的RDoc必須證明:

度特(時間,地點)=>布爾,DOIT(什麼)=>數組

而不是實際的方法簽名。

回答

0

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

我看到很多建議使用YARD代替,它有一個標記@overload,它符合相同的目的。

相關問題