Jaka jest poprawna obudowa do użycia w komentarzach jsDoc?

Question

Niedawno zacząłem używać komentarzy jsdoc do dokumentowania naszego kodu javascript, jednak znajduję sprzeczne przykłady użycia tagu @param.

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

i https://developers.google.com/closure/compiler/docs/js-for-compiler (camel/małe litery).

camelCase sens dla mnie, ponieważ:

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

Jaka jest prawidłowa obudowa użyć do uwag JSDoc @param? Czy to nie ma znaczenia? Planuję go wykorzystać do generowania dokumentów, a także do uruchomienia kodu przez zamknięcie google, aby uzyskać kontrolę typu.

Dzięki!

Answer 1

Spierające przykłady ekspresji typu JSDoc angażować JavaScript pierwotne typu string, number i boolean, które mają odpowiednie typy Wrapper: String, Number i Boolean.

Od Closure: The Definitive Guide:

Zastosowanie typów owinięcie jest zabronione w Closure Library, jak niektóre funkcje mogą nie zachowywać się poprawnie, jeśli używane są typy wrapper gdzie oczekiwane są prymitywne typy.

See MDN: Distinction between string primitives and String objects.