R包开发：如何为未自定义的show泛型编写Roxygen文档？

嘿，我之前也碰到过一模一样的问题！原因其实很简单：R会自动为你的S4类myclass生成默认的length方法，但这个自动生成的方法没有对应的文档，所以R CMD check就会抛出那个警告。下面给你几种实用的解决办法：

方法1：把方法文档附加到类文档里（最推荐） #

你不需要自己重写length的逻辑，只需要用roxygen2给这个默认方法补个文档就行。在你的包代码里（比如和myclass类定义同一个R文件）加上这段代码和注释：

#' @describeIn myclass 获取myclass对象的长度
#' @param x 一个myclass类的实例对象
#' @export
setMethod("length", signature(x = "myclass"), function(x) {
    # 直接继承R的默认length实现，不用自己写逻辑
    callNextMethod()
})

@describeIn标签的作用是把这个方法的文档直接附加到myclass类的文档页面中，这样用户查看类文档时就能一起看到相关方法，逻辑更连贯。

方法2：为方法生成独立文档页面 #

如果你希望length方法有单独的文档页面，可以用@exportMethod标签：

#' 获取myclass对象的长度
#' @param x 一个myclass类的实例对象
#' @exportMethod length
setMethod("length", signature(x = "myclass"), function(x) {
    callNextMethod()
})

不过这种方式会生成单独的length-myclass文档页面，除非你有特殊需求，否则方法1的方式更简洁。

方法3：禁用这个方法（如果不需要的话） #

要是你的myclass对象根本不需要支持length操作，那可以显式写一个抛出错误的实现，同时补上文档：

#' @describeIn myclass 不支持length操作
#' @param x 一个myclass类的实例对象
#' @export
setMethod("length", signature(x = "myclass"), function(x) {
    stop("myclass类型的对象不支持length操作")
})

这样既解决了文档警告，又能明确告诉用户这个方法不可用，避免误用。

最后别忘了，修改完注释后一定要运行devtools::document()（或者roxygen2::roxygenize()）更新包的文档，然后再重新跑R CMD check，那个警告就应该消失啦！

内容的提问来源于stack exchange，提问作者anamaria