roxygen 中是否有参数类型的规范语法？

Question

我将 R 与 Roxygen 一起使用。你有 @param 块，就像在 Doxygen 和 JavaDoc 中一样。因为 R 是动态类型的（甚至是鸭子类型的），所以没有类型信息，就像 C++ 或 Java 那样。对于 PHP 和 Python，我已经看到可以在 PHPDoc 中使用 @param int $n，在 Sphinx 中使用 :param int n:（对于 Python）。

Roxygen 似乎缺少此功能，各种风格指南只是描述了类型（英文）。是否有一些规范的或至少是明智的方法来对此进行标准化？

我想获得如下信息：

类型 class myClass
长度为 3 的数值向量
每个都有特定字段的命名列表

也许使用

@param x A named list with fields "a", "b", and "c" which are logical. 
    These selects whether the three methods are to be used.

或者

@param x Selectors for the methods "a", "b", and "c".
    (Named list of logical).

抽象起来有很多种可能性：

类型：说明。
说明。输入。
（类型）说明。
…

在 Doxygen 和 PHPDoc 中，我得到了第三列（参数名称、类型、描述），但在这里我只需要处理两列。这可以在 R 中明智地解决吗？

Answer 1

我不确定是否存在普遍认可的标准，但一种选择是在描述包通过 data() 提供的对象时遵循 roxygen 生成的语法。

例如，如果您的包中包含一个包含对象

的文件data/myList.R

myList <- list (A = 1, B = 2, C = 3, D = 4)

那么此项可能会使用 roxygen 语法

最低限度地记录在 R/data.R 中

#' My List
#' @keywords datasets
"myList"

roxygen 将自动记录对象的格式为

An object of class list of length 4.

这种结构似乎也是描述参数时要遵循的明显语法，尽管这必须手动完成。通用解决方案可能无法实现，因为某些函数可以处理具有各种属性和类.

的参数

roxygen 中是否有参数类型的规范语法？

Is there a canonical syntax for parameter types in roxygen?

r

roxygen2