如何为函数编写roxygen2标签且避免devtools::document()生成Rd文件?
解决R包内部函数文档不生成Rd文件的问题
你提到的@noRd标签其实正是roxygen2专门为这类场景设计的完美解决方案,完全匹配你的需求!下面给你详细拆解用法和注意事项:
@noRd的核心作用:当你在roxygen2文档块中添加@noRd标签后,roxygen2在生成包文档时会跳过该函数的Rd文件生成流程——内部函数的注释文档只会留在你的R脚本里供团队开发者查看,不会随包发布给终端用户。正确使用示例:你给出的代码写法完全规范,就是标准的用法:
#' Add two numbers #' @param x Numeric vector #' @param y Numeric vector #' @return Numeric vector #' @noRd add = function(x, y) { x + y }
运行devtools::document()后,去包的man/目录检查,会发现并没有生成对应的add.Rd文件,完全符合你的预期。
- 额外实用小贴士:
- 如果有大量内部函数,你可以把它们统一放在单独的脚本(比如
R/internal.R)里,配合@noRd逐个标记,管理起来更清晰。 - 若想批量控制,也可以在包的
DESCRIPTION文件中做配置,但@noRd是更精准的单函数级控制方式,灵活性更高。
- 如果有大量内部函数,你可以把它们统一放在单独的脚本(比如
内容的提问来源于stack exchange,提问作者Jonas Lindeløv
相关产品推荐
相关产品推荐

