记录功能关闭

Question

假设我的包中有一个函数闭包，例如

f = function(x) {
    x = x
    g = function(y) x <<- y
    h = function() x
    list(g = g, h = h)
}

l = f(5)
l$g(10)
l$h()

记录此功能的正确（在官方CRAN意义上）是什么方式？特别是，

1. 我想使用roxygen2
2. 我想提供函数g和h
的文档

Answer 1

一种方法是执行与?family类似的操作，在g()文件的h()部分中记录Value和.Rd。然后在定制的g()中提供有关h()和\section{foo}的扩展文档，您可以在这两个函数的Value部分条目中指出。

\value{
  Returns an object of class \code{"foo"}, a list with the
  following components:

  \item{g}{function; does foo. See Returned Functions for details.}
  \item{h}{function; does bar. See Returned Functions for details.}
}
\section{Returned Functions}{
  The returned functions do, blah blah...

  \code{g} is defined as

  \preformatted{
  g(x, y, z, ...)
  }

  Arguments are:

  \describe{
    \item{x}{foo}
    \item{y}{foo}
    \item{z}{foo}
  }
}

虽然roxygen无法通过参数@param执行此操作，但您应该能够将其写为任意roxygen部分以添加到Rd文件中。 Value部分可以写成标准的roxygen标记，只需要按字面输入定制部分。