R package/function -为函数参数添加黄色注释框

Question

我正在尝试写我的第一个R-package，我想知道当你将鼠标悬停在函数参数上(当你在函数中按tab键时)，如何添加那些弹出的黄色注释框。请看这里：

​

​

这是我的代码：

#' 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 = ","))
  }
}

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

你知道问题出在哪里吗？

Answer 1

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