可以在 roxygen2 代码块中使用换行符吗?
Possible to use newline inside roxygen2 code block?
我想知道在记录函数时是否可以在 roxygen2 的代码块中插入换行符?
如果我在 \code{}
里面有东西,roxygen2 默认会将所有换行符折叠成单个空格。我尝试在里面插入 \cr
以强制换行,我得到了想要的行为,但是当我 "R CMD CHECK" 时我收到警告。有办法吗?
示例:
#' \code{
#' multiple
#' lines
#' }
使用 \preformatted
而不是 \code
。 \code
用于内联代码(类似于 ``
在 SO 上),\preformatted
用于逐字块(如 SO 上的缩进)。
#' \preformatted{
#' multiple
#' lines
#' }
请注意,{
之后的初始换行符也将成为代码块的一部分,因此您可能需要考虑将其删除。
我想知道在记录函数时是否可以在 roxygen2 的代码块中插入换行符?
如果我在 \code{}
里面有东西,roxygen2 默认会将所有换行符折叠成单个空格。我尝试在里面插入 \cr
以强制换行,我得到了想要的行为,但是当我 "R CMD CHECK" 时我收到警告。有办法吗?
示例:
#' \code{
#' multiple
#' lines
#' }
使用 \preformatted
而不是 \code
。 \code
用于内联代码(类似于 ``
在 SO 上),\preformatted
用于逐字块(如 SO 上的缩进)。
#' \preformatted{
#' multiple
#' lines
#' }
请注意,{
之后的初始换行符也将成为代码块的一部分,因此您可能需要考虑将其删除。