R引用类的Docstring格式

R引用类的Docstring格式,r,docstring,reference-class,R,Docstring,Reference Class,我有一个特别的问题,但是有一个“教人钓鱼”的问题 我正在使用引用类编写一个R包。如上所述,我在每个方法中放置docstring,然后roxygen将其拾取并放入类的文档(Rd)文件中。下面是一个示例方法以及docstring: MyClass$methods(mymethod = function(argument) { "Do something useful \\subsection{Parameters}{ \\itemize{ \\item{\\code{argument

我有一个特别的问题,但是有一个“教人钓鱼”的问题

我正在使用引用类编写一个R包。如上所述,我在每个方法中放置docstring,然后roxygen将其拾取并放入类的文档(Rd)文件中。下面是一个示例方法以及docstring:

MyClass$methods(mymethod = function(argument) {
  "Do something useful
  \\subsection{Parameters}{
  \\itemize{
  \\item{\\code{argument} A useful argument.}
  }}
  \\subsection{Return Value}{Always returns 42}
  \\subsection{Example}{
  \\code{ cl <- MyClass$new() }
  \\code{ cl$mymethod() } 
  \\code{ cl$mymethod(12) }}"
  return(42)
})
MyClass$methods(mymethod=function(参数){
“做些有用的事
\\第{参数}小节{
\\逐项列举{
\\项{\\code{argument}一个有用的参数。}
}}
\\子节{返回值}{始终返回42}
\\第{例}小节{

\\代码{cl看一下编写R扩展手册。实际上还有一个
\\examples
部分,您可能也想使用。请参阅该部分。啊……我明白了。docstring是Rd格式的。很明显,现在您说它=)。请随意回答,我会接受的!
cl <- MyClass$new() cl$mymethod() cl$mymethod(12)