Javascript 如何对BackboneJS代码进行jsdoc注释?
有人用JSDoc记录过BackboneJS代码吗 我在注释主干结构时遇到问题,例如:Javascript 如何对BackboneJS代码进行jsdoc注释?,javascript,backbone.js,jsdoc,Javascript,Backbone.js,Jsdoc,有人用JSDoc记录过BackboneJS代码吗 我在注释主干结构时遇到问题,例如: User=Backbone.Model.extend({ 默认值:{a:1}, 初始化:函数(){ // ... }, 剂量测定:功能(p){ // ... } }); 谢谢你的建议。谢谢。如果您正在谈论JSDoc工具包,我认为它是这样工作的: User = Backbone.Model.extend( /** @lends User.prototype */ { /** * @class Use
User=Backbone.Model.extend({
默认值:{a:1},
初始化:函数(){
// ...
},
剂量测定:功能(p){
// ...
}
});
谢谢你的建议。谢谢。如果您正在谈论JSDoc工具包,我认为它是这样工作的:
User = Backbone.Model.extend(
/** @lends User.prototype */
{
/**
* @class User class description
*
* @augments Backbone.Model
* @constructs
*
* Text for the initialize method
*/
initialize: function() {}
})
重要的一点是@lends
标记的位置
这可能有点棘手,但如果这不起作用,请尝试其他一些例子:chris_b的回答对我帮助很大,包括示例和链接。不过,我不得不删除
@class
注释,否则它会为类生成两个条目。此外,我添加这个答案是为了说明如何注释静态类成员(类级常量)
(我们使用require.js。)
因为JSDoc是JavaDoc的一个端口。所以它不是为JavaScript设计的。一般来说,使用@ Raynos是正确的,但是JSDoc仍然有一个巨大的好处:它可以在IDE中给你自动完成。@ GeorgiyIvankin,你给我看了一个IDE,它在没有复杂的JavaScript项目的情况下,完全自动完成自动完成,然后我会考虑这个“好处”。我没有找到这样的IDE@Raynos例如,在中,您可以这样做:当然,事情并不像Java那样完美,但本示例中所示的内容已经大大简化了在单独文件中包含大量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;
});