在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

*.Rd处理时生成此文件roxygenize():

\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}
}