如何为可变参数函数编写Doxygen注释,即具有未定义数量的参数的函数？

Question

我正在尝试为具有无限数量参数的函数编写doxygen块注释,然后我找不到正确的标记.提供的参数应该都是字符串,并且它们将在函数中连接以形成新的字符串.

doxygen标签的正确用途是什么？

Answer 1

我经常在phpdoc中看到的模式(doxygen理解的格式)是:

/** 
 * Shortdesc.
 * Longdesc.  Longdesc.  Longdesc.  Longdesc.  
 * @param mixed $something Description
 * @param mixed ... Description
 */
    function foo() { ... }

是的,字面意思...是变量名.

Answer 2

实际上,phpDocumentor上的语法是 $paramname,...

/**
 * Builds a file path with the appropriate directory separator.
 * @param string $segments,... unlimited number of path segments
 * @return string Path
 */
function file_build_path(...$segments) {
    return join(DIRECTORY_SEPARATOR, $segments);
}