如何jsdoc注释BackboneJS code？ [英] How to jsdoc annotate BackboneJS code?

问题描述

有没有人记录BackboneJS code。与JSDoc？

Has anyone ever documented BackboneJS code with JSDoc?

我有问题注释主干结构，如：

I'm having problems annotating Backbone constructs such as:

User = Backbone.Model.extend({

    defaults: { a: 1 },

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

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

任何意见AP preciated。谢谢你。

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 标签的位置！

它可以是一个有点棘手，但如果这不起作用尝试一些其他的例子：<一href=\"http://$c$c.google.com/p/jsdoc-toolkit/wiki/CookBook\">http://$c$c.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 code？的文章就介绍到这了，希望我们推荐的答案对大家有所帮助，也希望大家多多支持IT屋！