2012-02-27 11 views

risposta

24

Utilizzando commenti JavaDoc-stile per JavaScript, è possibile dichiarare un parametro come optional con parentesi quadre [] intorno ad esso:

/** 
* My function 
* @param [optionalParam] An optional parameter 
*/ 
myFunction: function(optionalParam) { 
    //... 
}, 
+1

Bella soluzione, anche se stai usando il compilatore di chiusura di Google, potresti non voler usare questa notazione dal momento che è incompatibile, IIRC. – James

1

È possibile modificare le impostazioni tramite ispezioni opzione per JS:

enter image description here

+0

funzione con troppi parametri - non è questa ispezione su una funzione che ha molti parametri 'f (a, b, c, d, e)', e non sul chiamare una funzione e non passare gli argomenti opzionali? Questa impostazione è disattivata, quindi non deve essere così. Stavo pensando ad un modo per documentare un parametro opzionale. – ripper234

7

"JavaScript> Generale> Firma non corrispondente problema" è l'impostazione di controllo che consente di disattivare l'errato-number-di -parametri che avvisano per te Sfortunatamente, riguarda più del semplice conteggio dei parametri. Secondo la descrizione all'interno di IntelliJ IDEA, "Controlla JavaScript chiamato parametri di funzione, valori di ritorno, espressioni assegnate di tipo corretto.La convalida funziona in JavaScript, html o file jsp."

Turn off JavaScript parameter count warnings (and all type warnings as well)

1

Secondo http://usejsdoc.org/tags-param.html ci sono due modi di utilizzare i commenti per dichiarare un parametro come optional:

/** 
* @param {string} [somebody] - Somebody's name. 
*/ 
function sayHello(somebody) { 
    if (!somebody) { 
     somebody = 'John Doe'; 
    } 
    alert('Hello ' + somebody); 
} 

e

/** 
* @param {string=} somebody - Somebody's name. 
*/ 
function sayHello(somebody) { 
    if (!somebody) { 
     somebody = 'John Doe'; 
    } 
    alert('Hello ' + somebody); 
} 

Entrambi i modi hanno funzionato per me.

Problemi correlati