如何顯示返回的列表中Roxygen的元素呢？

Question

我可以很容易地輸入參數，通過做這樣具有@param多行做到這一點：

#' @param var1 This is for x 
#' @param var2 This is for y 
#' @param var3 This is for Z 

但你如何做一個列表的元素你正在返回。我想包括每個元素的名稱和關於他們的描述。串聯起來@return或@param不具有相同的行爲。什麼是適當的標籤？

#' @return A list with the following elements: 
#' @something element1 Contains x 
#' @something element2 Contains y 
#' @something element3 Contains z 

samr有確切的降價格式我在尋找的包裝：

Answer 1

從手動 - http://roxygen.org/roxygen2-manual.pdf

@return用來記錄該函數返回的對象。對於列表，使用\ {項目名稱 一} {說明A}描述列表