在Roxygen中logging时：如何在@details中创build分项列表？

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

看来，换行符简单地被忽略，即

#' @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} ##' } ##' 

这将允许您在详细信息部分使用分项。 你也可以在@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标记添加到单个文件。