没有导出的Rd

Question

我在记录一个内部的、非导出的函数。roxygen2正在创建Rd文件，尽管文档中没有@export标记。roxygen2为以下文档创建了Rd文件。我遗漏了什么？

    #' Check validity of a
    #' @param a A logical value
    arg_check_a = function(a) {
      if (!is.logical(a)) {
        stop("a must be a logical value")
      }
    }

Answer 1

使用@noRd。

使用@noRd标记防止生成.Rd文件。

我也喜欢将它们标记为#' @keywords internal (根据小插曲)：

@keywords internal很有用，因为它将函数从文档索引中删除；它对于主要针对其他开发人员的函数非常有用，而不是针对包的典型用户。

(其中大部分来源于https://github.com/r-lib/roxygen2/issues/684)