2012-02-27 12 views

Respuesta

24

uso de comentarios de tipo Javadoc de JavaScript, puede declarar un parámetro como opcional con corchetes [] alrededor de él:

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

Buena solución, aunque si está utilizando el compilador de cierre de Google, entonces puede que no desee utilizar esta notación ya que es incompatible, IIRC. – James

1

Puede cambiar la configuración a través de inspecciones opción para JS:

enter image description here

+0

función con demasiados parámetros - ¿no es esta inspección acerca de una función que tiene una gran cantidad de parámetros 'f (a, b, c, d, e)', y no se trata de llamar a una función y no pasar argumentos opcionales? Esta configuración está desactivada, por lo que no debe ser así. Estaba pensando en alguna forma de documentar un parámetro opcional. – ripper234

7

"JavaScript> General> Firma falta de coincidencia de problemas" es el ajuste de inspección que desactiva el número incorrecto de -parametros de advertencia para usted. Lamentablemente, afecta más que solo el conteo de parámetros. De acuerdo con la descripción dentro de IntelliJ IDEA, "Verifica los parámetros de funciones llamados JavaScript, los valores de retorno, las expresiones asignadas para que sean del tipo correcto. La validación funciona en archivos JavaScript, html o jsp".

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

1

Según http://usejsdoc.org/tags-param.html hay dos maneras de utilizar los comentarios para declarar un parámetro como opcionales:

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

y

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

Ambas formas funcionaron para mí.

Cuestiones relacionadas