Roxygen документация по спискам

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 символов, чтобы быть официальным ответом.