jsdoc

    2

    1答えて

    私は太い矢印の関数でparamに注釈を付ける方法を見つけるのに苦労しています。ここで、私は例であなたにそれを表示してみましょう: angular.forEach(someIterable, (item, key) => { // here I need item to be annotated }) だから私は試してみました: /** * @param {MyType} item

    1

    1答えて

    私はこのようなモジュールを持っているを参照してください。 /** * Do something with target. A bunch of these methods * @param target */ function doJob(target) { target.something = 'value'; } module.exports = { doJo

    1

    1答えて

    Fooというコンストラクタ関数があり、ユーザにnewを指定せずに呼び出させます。例えば、Fooため const myFoo = Foo('bar'); は、私がJSDoc3でこれを文書化するにはどうすればよい function Foo(bar) { if(!this) { return new Foo(bar); } foo.bar = bar; return t

    0

    1答えて

    私はjsdocとdocdashで始まり、すべてがこれまでのところokだと思われます。しかし、私のモジュールなどがゆっくりと文書化されているにもかかわらず、生成されるindex.htmlファイルに項目を追加する方法がわかりません。ルートHTMLファイルに項目を生成するためにファイルにはどのようなマークアップが必要ですか? 詳細については、左側のナビゲーションペインの上部に「ホーム」リンクがあります。

    3

    1答えて

    など。 MyClass.js /** * @class * @name module:Bar * @param {number} a1 * @param {string} a2 */ function Bar(a1, a2){} そして、別のファイルに: /** @type module:Bar.constructor */ // made up syntax var Bar =

    3

    1答えて

    返されたJSON結果をサーバーに文書化するにはどうすればよいですか? 例 /** * Gets a user's data * @returns {jQuery} */ function getUserData(userId){ return $.get('/usr/' + userId); } 上記の例では、返されたデータは、フェリックスが指摘するように、戻り値がJSON

    2

    1答えて

    最近、私はJSDocの使用を開始しました。あなたが使用することをお勧めします何JSDocのタグ $(".crop-img").click(function(){ $("#bigImg").attr('src', $(this).attr('src')); }); :私は、HTMLでのグラブのクラスにはjQueryを使用し、匿名関数で定義されたアクションを実行し、私のJS

    1

    1答えて

    返り値が一貫しない関数に対して、JSDocアノテーションを追加することは可能ですか?@return /** * @param {Number} a * @param {Number} b * @return {Number} * */ function sum (a, b) { if (a < b) return false; //here we have a Boolean