Załóżmy, że mam blok komentarza, w którym chciałbym napisać adres e-mail. Jak miałbym uciekać przed symbolem "@", tak, że roxygen traktuje to jako tekst zamiast dyrektywy?Escaping "@" w dokumentacji Roxygen2 Style
Wykonanie podwójnego atrybutu @@.
Jako przykład weźmy adres e-mail w polu Autor tej dokumentacji:
##' A package to check Roxygen's sanity.
##' @name helloRoxygen-package
##' @docType package
##' @author My name \email{[email protected]@here.org}
NA
która produkuje ten plik *.Rd gdy przetwarzany 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{[email protected]}
}
Podwójna tęcza? ;) –
Z miłością można zauważyć tutaj, jak @ symbole obsługiwane podczas uzyskiwania dostępu do gniazd w kodzie @example. – tim
@tim - W jaki sposób są obsługiwane? Czy wymagają specjalnego traktowania, czy też autorzy roxygen zezwalają na przykład, aby przykładowy kod był przekazywany dosłownie? –