如何 jsdoc 注释 BackboneJS 代码?

本文介绍了如何 jsdoc 注释 BackboneJS 代码?的处理方法，对大家解决问题具有一定的参考价值，需要的朋友们下面随着小编来一起学习吧！

问题描述

有没有人用 JSDoc 记录过 BackboneJS 代码?

Has anyone ever documented BackboneJS code with JSDoc?

我在注释 Backbone 结构时遇到问题，例如:

I'm having problems annotating Backbone constructs such as:

User = Backbone.Model.extend({

    defaults: { a: 1 },

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

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

任何建议表示赞赏.谢谢.

Any advice appreciated. Thanks.

推荐答案

我认为它的工作原理是这样的，如果你在谈论 JSDoc 工具包:

I think it works somehow like this, if you're talking about the 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 标签的位置！

The important bit is the position of the @lends tag!

这可能有点棘手，但如果这不起作用，请尝试其他一些示例:http://code.google.com/p/jsdoc-toolkit/wiki/CookBook

It can be a bit tricky, but if this doesn't work try out some of the other examples: http://code.google.com/p/jsdoc-toolkit/wiki/CookBook

这篇关于如何 jsdoc 注释 BackboneJS 代码?的文章就介绍到这了，希望我们推荐的答案对大家有所帮助，也希望大家多多支持！