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

Question

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

Answer 1

经过一番尝试和错误后，这就是我的想法。该解决方案确保所有对象都正确导出，R CMD 构建/检查不会呕吐，没有冗余文档，并且示例将执行。请注意，如果将@export 替换为@method/@S3method，则该解决方案将不起作用。理论上这应该有效，但对我来说却不起作用。有人有更好的解决方案吗？

#' Title.  More Info.
#'
#' @param someParam  Param info.
#'
#' @name     MyMethod
#' @export   MyMethod
NULL
#' @rdname   MyMethod
#' @name     MyMethod.ClassName
#' @export   MyMethod.ClassName
setMethodS3( "MyMethod" , "ClassName" , appendVarArgs = FALSE , 
function( this , someParam ) { ... } )