可能的重复：
如何使用 Roxygen2 正确记录 S4 类插槽 https://stackoverflow.com/questions/7368262/how-to-properly-document-s4-class-slots-using-roxygen2

我想构建一个包含以下内容的包S4 classes使用 R Studio 和roxygen2。 我已经使用记录了我的所有功能roxygen2当我介绍几个语法时S4 classes到我的包裹。

现在我意识到没有现成的“@slot”功能。所以我想知道如何保留其他功能的所有文档工作并记录S4 classes手动像建议的那样这个线程 https://stackoverflow.com/questions/7368262/how-to-properly-document-s4-class-slots-using-roxygen2?

或者换句话说，您会建议使用哪种工作流程来构建一个既包含旧式功能又包含旧式功能的包S4 classes?

编辑：您是否建议将 R Studio 构建的工具配置为不创建 .Rd 文件。roxygenize手动然后添加信息？但这仍然会导致覆盖手动生成的类的 .Rd 文件......

有关 roxygen 和 S4 类别的一般信息

roxygen 的第一个版本有一个@slot标签，但该版本不再维护以支持roxygen2。所以建议不要使用旧版本。

就目前而言，roxygen2没有真正支持 S4 课程。哈德利正在努力实现这一目标roxygen3 (https://github.com/hadley/roxygen3 https://github.com/hadley/roxygen3）。如果您想尝试一下并感到勇敢：安装roxygen3来自 github 并尝试开发版本。请注意，该版本最终将并入roxygen2，所以问题最终会自行解决。

关于您的工作流程：

我个人总是觉得结合使用 roxygen 和手动编写的 .Rd 文件是一个坏主意。但如果必须的话，您可以使用参数将 roxygen 的输出发送到不同的目录roxygen.dir。这样您就可以将所需的任何内容复制回包目录中，而无需覆盖手动编写的文件。

roxygenise("./mypackage", roxygen.dir="./myroxygendir")

我要做的就是简单地使用roxygen2为您的类编写 Rd 文件，如您链接到的线程中所述。您不必像您认为的出于某种未知原因那样手动添加它们。你只需使用#'像往常一样指示 Rd 块，并使用您链接到的线程中给出的任何内容。如果您想让插槽成为一个单独的部分，您可以使用@section标签如下例所示。

暂时使用以下方法添加插槽的示例roxygen2 :

#' The MY class
#'
#' This class blabla yadayada
#'
#'@section Slots:
#'  \describe{
#'    \item{\code{aslot}:}{Object of class \code{"numeric"}, containing 
#'whatever and a bit more}
#'    \item{\code{anotherslot}:}{Object of class \code{"character"}, containing
#' strings.}
#'  }
#'
#' @note Yes, you can add notes
#' @name MY 
#' @rdname MY
#' @aliases MY-class
#' @exportClass MY
#' @author Joris Meys
setClass("MY",
         representation=representation(aslot="numeric",
                                       anotherslot="character"
                                       )