Welches Gehäuse ist für jsDoc-Kommentare geeignet?

Question

Ich habe vor kurzem begonnen, jsdoc-Kommentare zu verwenden, um unseren JavaScript-Code zu dokumentieren, allerdings finde ich widersprüchliche Beispiele für die Verwendung des @ param-Tags.

Siehe https://code.google.com/p/jsdoc-toolkit/wiki/TagParam (Pascal)

und https://developers.google.com/closure/compiler/docs/js-for-compiler (Kamel/Kleinschreibung).

Camelcase macht Sinn für mich seit:

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

Was ist das richtige Gehäuse für jsDoc @param Kommentare zu bedienen? Oder spielt es keine Rolle? Ich plane, es für die Dokumentgenerierung zu verwenden sowie den Code durch Google-Schließung laufen zu lassen, um Typprüfung zu erhalten.

Danke!

Answer 1

Die widersprüchlichen Beispiele für JSDoc Typ Ausdrücke beinhalten die JavaScript-Urtyp string, number und boolean, die entsprechenden Wrapper-Typen haben: String, Number und Boolean.

Von Closure: The Definitive Guide:

Die Verwendung von Wrapper-Typ ist verboten in den Closure Library, wie einige Funktionen verhalten sich möglicherweise nicht richtig, wenn Wrapper-Typen verwendet werden wo primitive Typen zu erwarten sind.

See MDN: Distinction between string primitives and String objects.