Question

到目前为止，我正在学习Roxygen并取得良好进展。我已经能够记录我正在处理的大部分软件包，但是我有一些我似乎无法正确理解的地方。请考虑以下最小R：

##' Test Roxygen Comments
##'
##' This is a test of the Roxygen System. Had this been actual
##' documentation, it may have contained information about the
##' directives and/or structures below.
##'
##' @name simple
##' @docType data
##' @rdname simple

variable <- list(
                 ##' itema comments
                 itema <- c("bing", "bang", "bong"),

                 ##' itemb comments
                 itemb <- "fooflakes"
)

##' More info abuot variable!
##' @rdname simple

list()内的评论刚刚被Roxygen删除我已经证实了这一点：

> parse.file("package-test/R/simple.R")
$`1`
$`1`$description
[1] "Test Roxygen Comments\n\nThis is a test of the Roxygen System. Had this been actual\ndocumentation, it may have contained information about the\ndirectives and/or structures below.\n\n"

$`1`$name
[1] "simple\n"

$`1`$docType
[1] "data"

$`1`$rdname
[1] "simple"

$`1`$assignee
[1] "variable"

$`1`$srcref
$`1`$srcref$filename
[1] "package-test/R/simple.R"

$`1`$srcref$lloc
[1] 11  1 17  1  1  1

我有一个选项设置基础架构，我想使用Roxygen来记录各个选项。我是否缩进评论似乎并不重要，将它们向左移动 - 左边似乎没有帮助。将@rdname添加到每个块似乎也没有帮助。我只是期待不存在的行为吗？在另一个问题中，接受的答案说我们可以在任何地方放置Roxygen评论并收集它们。

所以两个方面：上面我错过了什么，以及其他人如何记录个别数据项，如果不是我的尝试？

谢谢！

Answer 1

Roxygen不这样做。我还需要5个字符作为正式答案。

列表项的Roxygen文档

1 个答案: