可以在roxygen2代码块中使用换行符吗？

Question

我想知道在记录函数时是否可以在roxygen2中的代码块中插入换行符？

如果我在\code{}内有内容，roxygen2默认会将所有换行折叠为单个空格。我尝试在里面插入\cr来强制执行换行符，然后我得到了所需的行为，但是当我＆＃34; R CMD CHECK＆＃34;时我得到一个警告。有没有办法做到这一点？

示例：

#' \code{
#'   multiple
#'   lines
#' }

Answer 1

使用\preformatted代替\code。 \code用于内联代码（在SO上类似``），\preformatted用于逐字块（如SO上的缩进）。

#' \preformatted{
#'   multiple
#'   lines
#' }

请注意，{之后的初始换行符也将成为代码块的一部分，因此您可能需要考虑将其删除。