如何让roxygen2自动生成函数的@param标签？

完全可以自动生成，不用手动逐个敲@param标签，最常用的两种方式：

• RStudio内置快捷键（最方便）
  把光标定位到函数定义行（比如a_func <- function(x, y, z)这一行），按下对应快捷键：

  • Windows/Linux：Ctrl + Shift + Alt + R
  • Mac：Cmd + Shift + Option + R
    系统会自动生成完整的roxygen2文档模板，包含所有参数的@param标签，顺序和名称完全匹配函数定义，每个标签后面留空，直接填参数类型和描述就行，不会出现遗漏或顺序错误。

  比如你的示例函数，生成的模板会是这样：

  #' Title
  #'
  #' @param x 
  #' @param y 
  #' @param z 
  #'
  #' @return
  #' @export
  #'
  #' @examples
  a_func <- function(x, y, z) {
  
  }
  

• 用roxygen2函数生成模板（无RStudio时可用）
  如果用其他编辑器，直接调用roxygen2::template()函数，传入你的函数名，就能输出包含@param标签的文档模板。比如在控制台运行：

  roxygen2::template(a_func)
  

  会打印出对应的roxygen标签内容，复制到函数上方即可。

内容的提问来源于stack exchange，提问作者Chunhui Gu