2010-08-28 4 views
5

Comment doc un nombre variable de paramètres? J'écris une application en PHP et JavaScript. Actuellement j'ai (en JavaScript):Comment doc un nombre variable de paramètres

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

Alors, comment puis-je doc n-nombre de paramètres de chaîne?

+2

Vous ne savez pas si "doctype" est le bon choix de mot ici. –

+0

Voulez-vous dire comment écrire ces paramètres dans le jsdoc? – 2ndkauboy

+1

Demandez-vous Javascript ou PHP? Votre code est JS, mais vous avez accepté une réponse PHP. Si son PHP, s'il vous plaît changer (ou supprimer) l'exemple et également supprimer les balises javascript et jsdoc. Pour JS il y a déjà une réponse à cela dans la question liée (http://stackoverflow.com/questions/4729516/correct-way-to-document-open-ended-argument-functions-in-jsdoc). – studgeek

Répondre

12

E.g. PhpDocumentor suggère d'utiliser une ellipse

/** 
* 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() 
* @param mixed $v,... unlimited OPTIONAL number of additional variables to display with var_dump() 
*/ 
function fancy_debug($s,$v) 
{
+3

Battez-moi. Référence: http://manual.phpdoc.org/HTMLSmartyConverter/HandS/phpDocumentor/tutorial_tags.param.pkg.html –

+0

Cela ne semble plus fonctionner lors de l'utilisation de phpDocumentor2 – ChrisF

+1

Qu'en est-il de quand il est entièrement varargs comme 'function foo() { $ args = func_get_args(); ...} '? – SeldomNeedy

Questions connexes