jsdoc如何注释BackboneJS代码？
jsdoc如何注释BackboneJS代码？
提问于 2011-06-22 19:08:31
有没有人用JSDoc记录过BackboneJS代码？
我在注释主干结构时遇到了问题，例如：
User = Backbone.Model.extend({
defaults: { a: 1 },
initialize: function () {
// ...
},
doSomething: function (p) {
// ...
}
});任何建议都很感谢。谢谢。
回答 2
Stack Overflow用户
回答已采纳
发布于 2011-06-22 19:18:39
我认为它的工作原理是这样的，如果你谈论的是JSDoc工具包：
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
Stack Overflow用户
发布于 2013-08-22 23:27:29
chris_b的回答对我帮助很大，样本和链接都是如此。不过，我必须删除@class注释，否则它将为该类生成两个条目。此外，我添加此答案是为了说明如何注释静态类成员(类级别常量)。
(我们使用require.js。)
define([
'jquery', 'lodash', 'backbone'
], function($, _, Backbone) {
"use strict";
/**
* Enumeration of constants that represent the different types of Hedgehogs.
* @memberof models/Hedgehog
* @enum {string}
* @readonly
*/
var types = { 'type1': 'Type 1', 'type2': 'Type 2' };
var Hedgehog = Backbone.Model.extend(
/** @lends models/Hedgehog.prototype */
{
/**
* This is the model for Hedgehogs.
*
* @augments external:Backbone.Model
* @constructs
*/
initialize: function() {
// your code
},
// some more methods
}, {
// static class members
"types": types
});
return Hedgehog;
});页面原文内容由Stack Overflow提供。腾讯云小微IT领域专用引擎提供翻译支持
原文链接：
https://stackoverflow.com/questions/6438800
复制相关文章
相似问题
腾讯云开发者
