17

最近、JavaScriptコードを文書化するためにjsdocコメントを使用し始めましたが、@paramタグの使用法の矛盾する例を見つけています。

https://code.google.com/p/jsdoc-toolkit/wiki/TagParam（PascalCase）を参照してください

およびhttps://developers.google.com/closure/compiler/docs/js-for-compiler（camel / lowercase）。

キャメルケースは私にとって理にかなっています：

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

jsDoc @paramコメントに使用する正しい大文字小文字は何ですか？それとも関係ありませんか？私はそれをドキュメントの生成に使用するだけでなく、タイプチェックを取得するためにグーグルクロージャーを介してコードを実行することを計画しています。

ありがとう！

4

1 に答える 1

16

JSDoc型式の矛盾する例には、対応するラッパー型、、、およびを持つJavaScriptプリミティブ型およびがstring含まnumberれます。booleanStringNumberBoolean

閉鎖から：決定的なガイド：

プリミティブ型が予想される場所でラッパー型を使用すると、一部の関数が正しく動作しない可能性があるため、クロージャーライブラリではラッパー型の使用が禁止されています。

MDN：文字列プリミティブと文字列オブジェクトの区別を参照してください。

于 2013-03-20T04:29:34.277 に答える