转义“@”在 Roxygen2 风格文档中

Question

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

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{[email protected]}
}