Я изучаю 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 где угодно и что они будут собраны.
Итак, два раза: что мне не хватает выше, и как другие люди документируют отдельные элементы данных, если не так, как моя попытка?
Спасибо!
