可以在roxygen2代碼塊中使用換行符嗎？

Question

我想知道在記錄函數時是否可以在roxygen2中的代碼塊中插入換行符？

如果我在\\code{}有一些內容，默認情況下roxygen2會將所有換行符折疊為單個空格。 我嘗試插入\\cr來強制執行換行符，然后我得到了所需的行為，但是當我“R CMD CHECK”時我得到一個警告。 有沒有辦法做到這一點？

例：

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

Answer 1

使用\\preformatted而不是\\code 。 \\code用於內聯代碼（類似於`` on SO）和\\preformatted用於逐字塊（如SO上的縮進）。

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

請注意，在{之后的初始換行符也將是代碼塊的一部分，因此您可能需要考慮將其刪除。