Как написать комментарий Doxygen для функции с переменными значениями, то есть функции с неопределенным числом аргументов? - PullRequest
11 голосов
/ 05 апреля 2011

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

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

Ответы [ 2 ]

12 голосов
/ 06 апреля 2011

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

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

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

5 голосов
/ 08 марта 2014

На самом деле синтаксис 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);
}
...