Как написать комментарий Doxygen для переменной функции, т. Е. функции с неопределенным количеством аргументов?

Я пытаюсь написать комментарий к блоку doxygen для функции с неограниченным количеством параметров, но не смог найти для нее подходящий тег. Все предоставленные параметры должны быть строками, и они будут объединены в функции для формирования новой строки.

Как правильно использовать теги doxygen?

Author: Gordon, 2011-04-05
Source

2 answers

Шаблон, который я часто вижу в phpdoc (формат, который понимает doxygen):

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

Да, буквально ... как имя переменной.

 12
Author: Charles, 2012-04-05 12:14:11

На самом деле синтаксис 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);
}
 5
Author: Fred, 2014-03-08 15:12:52