现有泛型的 Roxygen 文档

【问题标题】：Roxygen documentation for existing generics现有泛型的 Roxygen 文档
【发布时间】：2018-03-21 13:46:10
【问题描述】：

我为我在包中定义的 S4 类 myclass 编写了一个 show() 方法。我使用 roxygen2 生成了类和方法的文档。一切正常，除了我在 R CMD 检查结果中收到以下警告：

检查缺少的文档条目...警告
未记录的 S4 方法：通用 'length' 和 siglist 'myclass'

我如何记录不是我自己写的show generic？

【问题讨论】：

【解决方案1】：

最后，使用明确的@aliases 和@docType 标签为我解决了这个问题。我的文档块现在看起来像这样：

#' Show method for objects of class \code{myclass}.
#'
#' @docType methods
#' @name show-myclass
#' @rdname show-myclass
#' @aliases show-myclass show,myclass-method
#'
#' @param x A \code{myclass} object.
#'
#' @export

【讨论】：