r - 在Roxygen中进行记录时:如何在@details中列出项目 list ？

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

似乎换行符只是被忽略了，即

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

谢谢!

最佳答案

这是问题解答之后的roxygen2示例。

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

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

希望这可以帮助。

关于r - 在Roxygen中进行记录时:如何在@details中列出项目 list ？，我们在Stack Overflow上找到一个类似的问题：https://stackoverflow.com/questions/9267584/