r - Roxygen2 文档参数乱序

Question

我正在使用 Roxygen2 进行文档编制，但我无法让参数的顺序正确。具体来说，我为这一组方法设置了 3 组参数：

• “n”：所有函数的参数，应该总是第一个
• “r”：一些函数的参数，应该总是第二个。在模板中
• p3-p5：模板中的一组参数；应该总是在结尾。
  • 它们分别以“s”、“a”和“r”开头

我无法将其按正确顺序排列：最常见的顺序是 n、p3-p5、r。如果我删除 n，我得到 p3-p5, r。如果我有 2 个 n，我得到 n，p3-p5，n，r。如果我有 2 个 r 而没有 n，我得到 p3-p5, r, r。

有关如何解决此问题的任何建议。如果您认为它与当前布局有关，它是：

#' @templateVar ... ...
#' @param n ...
#' @template t1 # Template for r
#' @template t2 # Template for p3-p5
#' @details  ... 
#' ...

其中 t2 的布局是：

#' @param p3
#' @param p4
#' @param p5
#' @details ...
#' @return  ...
#' ...

我发现的其他修复似乎不起作用。另外，我希望 n 成为 t2 模板的一部分，但我认为这是不合理的。

标签： rdocumentationdevtoolsroxygen2rd

Answer 1

好吧，恭喜我，因为我花了 45 分钟的时间试图弄清楚这一点，却没有意识到参数被命令与函数使用参数同步，而且 r 不应该在那里。

修复最终是“r”（或“r”代表的参数）没有直接匹配函数的任何参数，所以它被扔到最后。我觉得我好笨。不管怎样。也许这对未来的用户来说是一个很好的警告。