繁体   English   中英

Roxygen2文档参数故障

[英]Roxygen2 documentation parameter out of order

我正在使用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模板的一部分,但我认为这是不合理的。

好吧,恭喜我,因为我花了45分钟的时间试图弄清楚这一点,却没有意识到这些参数已与功能使用参数同步,并且r始终不应该存在。

修复最终导致“ r”(或“ r”代表的参数)与该函数的任何参数都不直接匹配,因此将其扔到了最后。 我觉得我好笨。 无论如何。 也许这将是对未来用户的一个很好的警告。

暂无
暂无

声明:本站的技术帖子网页,遵循CC BY-SA 4.0协议,如果您需要转载,请注明本站网址或者原文地址。任何问题请咨询:yoyou2525@163.com.

 
粤ICP备18138465号  © 2020-2024 STACKOOM.COM