r - 在 Roxygen 中记录时：如何在 @details 中制作逐项列表？

Question

例如，在@details 部分中，将逐项列表添加到 roxygen2 的适当语法是什么？我可以创建一个乳胶列表环境吗？

似乎换行符被简单地忽略了，即

#' @details text describing parameter inputs in more detail
#'
#' parameter 1: stuff
#' 
#' parameter 2: stuff

谢谢！

Answer 1

这是您提出问题后的 roxygen2 示例。

##'
##' @details text describing parameter inputs in more detail.
##' \itemize{
##'  \item{"parameter 1"}{Stuff}
##'  \item{"parameter 2"}{Stuff}
##' }
##'

这将允许您在详细信息部分使用 itemize。您也可以在 @param 部分中使用它。

希望这可以帮助。

Answer 2

从 roxygen2 6.0.0 开始，您可以直接在 R 文档中使用 markdown。

#' @details text describing parameter inputs in more detail.
#' * parameter 1 stuff
#' * parameter 2 stuff
#' @md

要使用它，要么Roxygen: list(markdown = TRUE)在您的描述中包含为整个包打开降价，要么将@md标签添加到单个文件中。