Экспонирование «@» в документации в стиле Roxygen2

StackOverflow https://stackoverflow.com/questions/8809004

  •  26-10-2019
  •  | 
  •  

Вопрос

Допустим, у меня есть блок комментариев, где я хотел бы написать адрес электронной почты. Как бы я сбежал из символа "@", так что Роксиген рассматривает его как текст вместо директивы?

Это было полезно?

Решение

Двойной AT-SIGN @@ сделает работу.

В качестве примера, возьмите адрес электронной почты в поле автора этой документации:

##' 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}
}
Лицензировано под: CC-BY-SA с атрибуция
Не связан с StackOverflow
scroll top