如何在roxygen2的@param标签间添加非参数文本?
在roxygen2的Arguments块中插入参数间子标题的方法
要在roxygen2生成的\arguments{}块内的参数定义之间添加自定义文本(比如子标题),可以用@rawRd标签直接插入Rd原生代码,绕过roxygen2对@param标签的文本合并逻辑。
具体写法示例:
#' 示例函数 #' #' @param x 参数x的描述 #' @rawRd #' 这里是参数x和y之间的自定义文本(比如子标题) #' @param y 参数y的描述 #' #' @export example_fun <- function(x, y) { # 函数逻辑 }
这段代码编译后生成的Rd文档中,\arguments{}块会变成:
\arguments{ \item{x}{参数x的描述} 这里是参数x和y之间的自定义文本(比如子标题) \item{y}{参数y的描述} }
@rawRd标签的作用是将其后的文本原封不动地插入最终的Rd文档,不会被roxygen2当作前一个@param的描述内容,完美实现常规Rd中的效果。
内容的提问来源于stack exchange,提问作者Noah
相关产品推荐
相关产品推荐

