在RStudio

Question

根据Google R styleguide或ROxygen自动设置R样式的功能生成评论结构的最简单方法是什么，包括：

• 简短说明
• 函数头的所有参数（如果可用）
• 返回值（如果有）
• 允许标签用户需要输入文字的字段

看起来像：

sampleFunction<- function(x, y, verbose = TRUE) {
  # [One line description]
  #
  # Args:
  #   x: [Arg description]
  #   y: [Arg description]
  #   verbose: [Arg description]
  #
  # Returns:
  #   [return description]

  return cov(x,y)
}

或

#' [One line description]
#'
#' @param x [Arg description]
#' @param y [Arg description]
#' @return [return description]
#' @examples
#' add(1, 1)
#' add(10, 1)
add <- function(x, y) {
  x + y
}