Roxygen2风格文档中如何转义“@”符号

Question

假设我有一个注释块，在其中我想写一个电子邮件地址。我该如何转义“@”符号，以便roxygen将其视为文本而不是指令？

- Brandon Bertelsen

Answer 1

两个连续的@符号@@可以实现此功能。

例如，以此文档的作者字段中的电子邮件地址为例：

##' A package to check Roxygen's sanity.
##' @name helloRoxygen-package
##' @docType package
##' @author My name \email{me@@here.org}
NA

使用roxygenize()处理时，会生成这个*.Rd文件：

\docType{package}
\name{helloRoxygen-package}
\alias{helloRoxygen-package}
\title{A package to check Roxygen's sanity.}
\description{
  A package to check Roxygen's sanity.
}
\author{
  My name \email{[e-mail]}
}

- Josh O'Brien

---

请注意，在访问 @example 代码中的插槽时，如何处理 @ 符号。 - tim

@tim -- 它们是如何处理的？它们需要特殊处理吗，还是roxygen的作者只允许示例代码逐字传递？ - Josh O'Brien