r - 如何在 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有我正在寻找的确切 Markdown 格式:

Answer 1

来自文档 - http://r-pkgs.had.co.nz/man.html#text-formatting

@return 用于记录函数返回的对象。对于列表，使用\item{name
a}{description a} 描述列表的每个组件