case sensitive - ¿Cuál es la carcasa correcta a utilizar para los comentarios de jsDoc?

case-sensitive google-closure-compiler

Question

Recientemente comencé a usar comentarios jsdoc para documentar nuestro código javascript, sin embargo, estoy encontrando ejemplos contradictorios del uso de la etiqueta @param.

Ver https://code.google.com/p/jsdoc-toolkit/wiki/TagParam (PascalCase)

y https://developers.google.com/closure/compiler/docs/js-for-compiler (camel / lowercase).

camelCase tiene sentido para mí desde:

var foo = 1;
console.log(typeof foo); // outputs "number"

¿Cuál es la carcasa correcta que se debe utilizar para los comentarios de jsDoc @param? ¿O no importa? Estoy planeando usarlo para la generación de documentos, así como para ejecutar el código a través del cierre de Google para obtener la verificación de tipos.

¡Gracias!

Answer 1

Los ejemplos en conflicto para las expresiones de tipo JSDoc involucran los tipos primitivos de JavaScript string , number y boolean , que tienen los tipos de envoltorio correspondientes: String , Number y Boolean .

Desde el cierre: La guía definitiva :

El uso de tipos de envoltorios está prohibido en la biblioteca de cierre , ya que algunas funciones pueden no comportarse correctamente si se usan tipos de envoltorios donde se esperan tipos primitivos.

Consulte MDN: Distinción entre primitivos de cadena y objetos de cadena .