记录引用类方法参数

时间:2014-09-30 15:32:07

标签: r

我知道引用类方法是使用docstring作为方法体的第一行内联记录的。有没有像使用S4方法那样记录方法参数的官方方法? Roxygen似乎没有拿起@param标签。

编辑1:

test <- setRefClass("test")
test$methods(method1 = function(x) {
"
@param x this is the x param
\\describe{
  \\item{\\code{x}}{some description}
}
"
})
test$help(method1)

这是一个简单的例子。加工胶乳但不加氧化标签。我并不是说roxygen中存在一个错误,因为它似乎符合R标准,所以我的猜测是没有人真正困扰记录RC方法的论点。我真正想知道的是,如果有一种“正式”或“最好”的方式来做这件事,因为我刚开始玩参考类。

0 个答案:

没有答案