r - 我如何记录 R 引用类？

Question

如何记录引用类成员函数的使用？

如果我写一个 Rd带有 \usage 的文件阻止，我该如何避免 WARNING

Functions/methods with usage in documentation object 'XmlDoc' but not in code:
  $ new

我希望 \usage阻止让我写这样的东西:

obj <- ClassName$new(par1, par2, ...)
obj$method1(oth1, ...)

然后我会在 \arguments 中记录参数堵塞。

如果我这样做， R CMD check提示

Assignments in \usage in documentation object 'ClassName':

并且不会将这些方法识别为我需要文档的代码对象。

截至目前，我正在写 Rd没有 \usage 的文件阻止并将上述代码写入 \examples块，但后来我没有地方记录参数，这样 check实际上很少检查。由于我对此不满意，我现在向社区询问当前的常见做法。

Answer 1

我不知道这是否是正确的方法，但我所做的是拥有一个 方法 部分，然后将方法文档放在内部 描述 .