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

Question

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

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

例：

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

Answer 1

使用\\preformatted而不是\\code 。 \\code用于内联代码（类似于`` on SO）和\\preformatted用于逐字块（如SO上的缩进）。

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

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