2013-03-19 10 views
16

私は最近、javascriptコードの文書化にjsdocコメントを使用し始めましたが、@paramタグの使用方法の例が矛盾しています。jsDocコメントに使用する正しいケーシングは何ですか?

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

https://developers.google.com/closure/compiler/docs/js-for-compiler(キャメル/小文字)を参照してください。

キャメルケースは、以来、私には理にかなって:

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

JSDocの@paramコメントに使用する正しいケースは何ですか?それとも問題じゃないの?私は、文書の生成にも、タイプチェックを得るためにGoogleクローズによるコードの実行にも使用する予定です。

ありがとうございます! StringNumber、およびBoolean:JSDocの型の式のため

答えて

16

矛盾の例は、対応するラッパー型を持っているJavaScriptのプリミティブ型stringnumberbooleanを伴います。 Closure: The Definitive Guideから

:ラッパー型がプリミティブ型が期待されている を使用している場合 いくつかの機能が正しく動作しない可能性が

ラッパー型の使用は、Closure Libraryで禁止されています。

MDN:Distinction between string primitives and String objectsを参照してください。

+3

ほとんどの場合、オブジェクト型ではなくプリミティブ型が必要です。コンパイラは、必要に応じてプリミティブ型を自動的にボックス化(昇格)しますが、その逆は真ではありません。 –

+0

ありがとうcpeisert!私は間違いなくその本を手に入れなければならない! – magritte

+0

は間違いありません。それは閉鎖情報だけでなく、素晴らしい読書です! – jordancpaul

関連する問題