私は最近、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クローズによるコードの実行にも使用する予定です。
ありがとうございます! String
、Number
、およびBoolean
:JSDocの型の式のため
ほとんどの場合、オブジェクト型ではなくプリミティブ型が必要です。コンパイラは、必要に応じてプリミティブ型を自動的にボックス化(昇格)しますが、その逆は真ではありません。 –
ありがとうcpeisert!私は間違いなくその本を手に入れなければならない! – magritte
は間違いありません。それは閉鎖情報だけでなく、素晴らしい読書です! – jordancpaul