R 包/函数 - 为函数参数添加黄色注释框答案

【问题标题】：R package/function - adding yellow comment boxes for function argumentsR 包/函数 - 为函数参数添加黄色注释框
【发布时间】：2018-03-12 03:33:12
【问题描述】：

我正在尝试编写我的第一个 R 包，并且想知道如何添加那些当您将鼠标悬停在函数参数上时弹出的黄色注释框（当您在函数中点击选项卡时）。见这里：

这是我的代码：

#' A web function
#'
#' This function allows you to call a website.
#' @param url put in a url
#' @keywords web
#' @export
#' @examples
#' webpage("google")

webpage <- function(url){
    if(!is.character(url)){
       url <- as.character(url)
} else{
     utils::browseURL(paste0("https://www.", url, ".com", collapse = ","))
  }
}

我使用带有 roxygen2 的 devtools 来记录和构建包 - 所有文件都在那里，并且包/功能在安装和加载后就可以工作。唯一的问题是，我写的评论 #' @param url put in a url 没有显示为黄色框。

知道问题可能是什么吗？

【问题讨论】：

黄色框看起来像 RStudio 而不是 R 本身。也许你应该添加 RStudio 标签。
您是否尝试重新启动 RStudio 并再次library您的包？
@VincentBonhomme，是的，我尝试重新启动 RStudio，并再次加载包，但它没有工作......我将它与其他 R 包进行了比较，以确保黄色框会弹出那些，他们做到了……
所以，它自己解决了......显然，当你有一个带有多个参数的函数时，你会得到一个所述参数的列表，如上图所示。当只有一个参数时，您必须开始输入参数并使用代码完成来显示列表。然后，当您将鼠标悬停在“url”参数上时，它会显示黄色描述框...
太棒了！那你能回答你自己的问题吗？

标签： r package rstudio devtools roxygen2

【解决方案1】：

问题自行解决了...显然，当您有一个带有多个参数的函数时，您会得到一个所述参数的列表，如上图所示。当只有一个参数时，您必须开始输入参数并使用代码完成来显示列表。然后，当您将鼠标悬停在“url”参数上时，它会显示黄色描述框...

【讨论】：