将@example标记与roxygen2一起使用时的文件位置_R_Roxygen2

将@example标记与roxygen2一起使用时的文件位置

将@example标记与roxygen2一起使用时的文件位置,r,roxygen2,R,Roxygen2,使用roxygen2记录函数时，可以将示例放在单独的文件中请看这里：您可以将示例放在单独的文件中，并使用@example path/relative/to/packge/root将其插入文档中，而不是直接在文档中包含示例在这里： e、 g 将两个数字相加。 #' #“@param x是一个数字。 #“@param是一个数字。 #“@返回\code{x}和\code{y}之和。 #'@example/path/to/example/add.R 添加在roxygen中使用的示例的适当位置为：

使用roxygen2记录函数时，可以将示例放在单独的文件中

请看这里：您可以将示例放在单独的文件中，并使用@example path/relative/to/packge/root将其插入文档中，而不是直接在文档中包含示例

在这里：

e、 g

将两个数字相加。 #' #“@param x是一个数字。 #“@param是一个数字。 #“@返回\code{x}和\code{y}之和。 #'@example/path/to/example/add.R

添加在roxygen中使用的示例的适当位置为：

inst/examples/

然后，roxygen线应为：

#' @example inst/examples/add.R

这是好的做法吗？我想是的，因为：

它使在开发过程中运行、修改和测试示例变得更加容易
这使得（至少在原则上）可以在文档中的不同位置重复使用示例，例如在小插曲中

我想/安装/移动到/安装软件包时？如果文档已经生成，我想这无关紧要。是的，

inst/examples

应该移到

examples

，我想您可以在文档中引用

/examples

。好的，inst/examples工作得很好。我可以在源代码中引用/inst/examples/file.R，然后使用devtools:：document（）创建文档/inst/examples移到了/examples，但我认为这是不相关的，因为文档已经构建好了……我无法决定这是否是一个好主意。它使运行示例变得更容易，但roxygen的全部要点不就是将文档放在函数定义位置的旁边吗？我发现当我有很多行用于示例的缩进时，它很有用，我想保留缩进。但大多数时候我仍然使用@examples。

#' @example inst/examples/add.R