r - 使用 Roxygen 记录 R.oo 类/方法

Question

有人能给我指出一个用 Roxygen 记录 R.oo 类/方法的好例子吗？在 R.oo 中，类/方法是通过调用 setConstructorS3() 和 setMethodS3() 来创建的，因此本身没有记录功能。您是否只是创建标准的 Roxygen 函数文档，但将其放在 NULL 语句之上？

Answer 1

我认为，

@usage需要。

MyMethod.ClassName 中需要点-点-点参数S3 通用/方法一致性的函数。

不是 #' @export MyMethod.ClassName而是#' @S3method MyMethod ClassName ?

示例代码:

#' Title.  More Info.
#'
#' @usage MyMethod(...)
#' @param this this.
#' @param someParam Param info.
#' @param ... other arguments.
#'
#' @rdname   MyMethod
#' @export   MyMethod
#' @name     MyMethod
NULL

#' @usage \method{MyMethod}{ClassName}(this, someParam, ...)
#' @return MyMethod.ClassName:
#' \code{NULL}
#'
#' @rdname   MyMethod
#' @S3method MyMethod ClassName
#' @name     MyMethod.ClassName
setMethodS3("MyMethod", "ClassName", appendVarArgs = FALSE, 
function(this, someParam, ...) {
  NULL
})