在Roxygen中进行记录时：如何在@details中列出项目清单？ [英] When documenting in Roxygen: How do I make an itemized list in @details?

问题描述

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

What is the appropriate syntax to add an itemized list to roxygen2, for instance, in the @details section? Can I create a latex list environment?

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

It seems that line breaks are simply ignored, i.e.

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

谢谢！

推荐答案

这里是遵循问题表达方式的roxygen2示例。

Here is a roxygen2 example following your problem formulation.

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

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

This will allow you to use itemize in details section. You can also use it in the @param sections.

希望这会有所帮助。

这篇关于在Roxygen中进行记录时：如何在@details中列出项目清单？的文章就介绍到这了，希望我们推荐的答案对大家有所帮助，也希望大家多多支持IT屋！