记录签名包含`<-`类的S4方法的正确方法是什么？答案

【问题标题】：What is the proper way to document S4 methods in which the signature contains the `<-` class?记录签名包含`<-`类的S4方法的正确方法是什么？
【发布时间】：2014-04-13 04:09:10
【问题描述】：

在 Formula.tools 包中，我为 A

#' @rdname formula.parts
#' @aliases rhs,set-method
setMethod( 'rhs', '<-', function(x) x[[3]] )

(n.b.签名列表'

对于这个 S4 方法，roxyger2-3.1.0，在 man/formula.parts.Rd 中生成以下内容：

\S4method{rhs}{<-}(x)

我认为正确的文档标签应该是：

\S4method{rhs}{`<-`}(x)

有没有办法强制 roxygen2 生成正确的 Rd 语法？我有点挣扎，但找不到方法。

背景

R-3.0.1
roxygen-3.1.0

【问题讨论】：

这只是一种解决方法，但@usage \S4method{rhs}{}(x) 有效吗？
@sgibb 是的，谢谢。 r @usage \S4method{rhs}{`<-`}(x) 确实生成了正确的 Rd 语法，但请参阅我自己问题的答案。这已在 roxygen2-4.0.0 中修复。

标签： r s4 roxygen2

【解决方案1】：

在向 roxygen 开发人员报告此 issue 后，我正在回答我自己的问题。这被证实在 roxygen2-4.0.0 之前不起作用。他们在一天之内推出了一个补丁。（太棒了！）Roxygen2 现在为带有

补充说明：升级到 roxygen2-4.0.0 需要 R >= 3.0.2 和最新版本的 Rcpp。

【讨论】：