Question

我正在编写一个程序包，并使用Roxygen2在源文件中构建文档（并使用pkgdown将其呈现为网站）。

到目前为止，我已经记录了所有关键的导出功能。

但是，程序包中有许多公开导出的命名项列表向量，其中包含我要记录的对象。

我可以将代码与函数一起放在顶部-但如果列表或列表中创建的对象很复杂（可能是我的-某些是某些清单的清单，例如用于发光的仪表板），那么这意味着文档和代码很容易不同步。

理想情况下，我想将文档内联地写到要记录的对象上，即。在列表中插入注释行，然后将其组装成最终文档。

有人可以建议采取任何整洁的方式吗？或可能对此有所帮助的工作模式？种类：

#' Filter list for MyAwesomeShinyApp
#' 
#' Creates a set of filter actions as quosures. The quosures should
#' be inserted into our dplyr::filter query using quasiquotation.
#' The available filters are as follows:
#'
#' @export
myListOfFilters <- list(

  #' first_filter sets up a really complicated filter using a function
  #' based on the dog's favourite toy.
  "first_filter" = reallyComplexFunction(dog, dogToy),

  #' second_filter only looks up dogs called Fido.
  "second_filter" = rlang::quo(.data[["DogName"]] == "Fido")
)

在此示例中，您可以看到列表中每个项目的内联文档如何随着列表大小的扩展变得更有意义。显然，此示例不起作用！问题是-有没有一种类似的工作方式？

如何最干净地使用Roxygen2在R

0 个答案: