Как документировать переменное количество параметров - PullRequest
5 голосов
/ 28 августа 2010

Как мне документировать переменное количество параметров?Я пишу приложение на PHP и JavaScript.В настоящее время у меня есть (в JavaScript):

/**
 * Description
 * @param {String} description
 */
function fn()
{
  // arguments holds all strings.
}

Итак, как мне документировать n-количество строковых параметров?

1 Ответ

12 голосов
/ 28 августа 2010

например. PhpDocumentor предлагает использовать многоточие

/**
 * Example of unlimited parameters.
 * Returns a formatted var_dump for debugging purposes
 * (since the recurrences of $v are not listed in the actual function signature in the code,
 * you may wish to highlight they are "optional" in their description)
 * @param string $s string to display
 * @param mixed $v variable to display with var_dump()
 * <b>@param mixed $v,... unlimited OPTIONAL number of additional variables</b> to display with var_dump()
 */
function fancy_debug($s,$v)
{
...