在 Roxygen2 样式文档中转义“@”答案

【问题标题】：Escaping "@" in Roxygen2 Style Documentation在 Roxygen2 样式文档中转义“@”
【发布时间】：2012-01-10 19:07:05
【问题描述】：

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

【问题讨论】：

【解决方案1】：

双 at-sign @@ 将完成这项工作。

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

##' 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{me@here.org}
}

【讨论】：

请注意在@example 代码中访问插槽时@符号的处理方式。
@tim -- 他们是如何处理的？它们是否需要特殊处理，或者 roxygen 作者只允许逐字传递示例代码？