在RStudio中自动插入注释

根据or自动为

R

中的函数生成注释结构的最简单方法是什么，包括：

• 简短的描述
• 函数头的所有参数（如果可用）
• 返回值（如果可用）
• 允许在用户需要输入文本的字段中使用tab键

看起来像：

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)
}

---

samplefunction听起来您应该深入研究函数的文档化风格。格式正确的函数可用于自动构造.Rd文档文件。制作一个通用的代码片段或要求RStudio像对待roxygen一样支持击键绑定。（顺便说一句，OSX上的shift-alt-cmd-R）+1代表罗曼的立场。谷歌的风格指南很好，除了roxygen之外，其他所有的都能让你在制作PKG的时候变得非常棒，你甚至可以制作Rds（以及HTML文档），甚至不带PKG。为什么要追随谷歌？
roxygen
和Ctrl+Alt+Shift+R分别在windows上实现了这一点。谢谢有人发布roxygen/RStudio/键盘快捷键作为答案吗？
#' [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
}