16

BackboneJS コードを JSDoc で文書化したことがありますか?

次のようなバックボーン構造に注釈を付ける際に問題があります。

User = Backbone.Model.extend({

    defaults: { a: 1 },

    initialize: function () {
        // ...
    },

    doSomething: function (p) {
        // ...
    }
});

アドバイスをいただければ幸いです。ありがとう。

4

2 に答える 2

27

JSDoc Toolkit について話している場合、次のように機能すると思います。

User = Backbone.Model.extend(
/** @lends User.prototype */
 {
  /**
   * @class User class description
   *
   * @augments Backbone.Model
   * @constructs
   *
   * Text for the initialize method
   */
    initialize: function() {}
})

大事なのは@lendsタグの位置！

ちょっと難しいかもしれませんが、うまくいかない場合は、他の例を試してみてください: http://code.google.com/p/jsdoc-toolkit/wiki/CookBook

于 2011-06-22T11:18:38.980 に答える