使用roxygen2仅继承某些参数

Question

在 roxygen2 中，可以使用标签

@inheritParams

来继承另一个函数的全套参数。但是否也可以仅继承其中的某个子集？ （不包括继承

...

的情况，

@inheritDotParams

已经充分处理了。）

Answer 1

在

functionA

的标题中：

@inheritParams functionB

，至少在 Roxygen 6.0.0 中，只会继承

functionA

中的参数，这些参数也可在

functionB

中找到。 任何共享但在

functionA

标头中定义的参数都不会从

functionB

继承。

因此，选择是内置的。

Answer 2

要继承外部包函数使用的共享参数的文档，您可以使用：

@inheritParams externalPackage::externalFunction