运行jsdoc命令生成html文件,我没有收到任何错误。模块:collections / queue module和QueueCollection类按预期显示。
在文档中没有显示@see标记,它们会被忽略。我无法弄清楚为什么。
另外,如何让文档显示所描述成员和方法的行号?
例如:Source: collections/queue.js, line 51
define([
"backbone",
// models
"models/entry"
],
/**
@exports collections/queue
@requires Backbone
@requires modules:models/entry
@example
// Load collection
require(['collections/queue'], function(QueueCollection) {
var queue = new QueueCollection();
});
*/
function(Backbone, EntryModel) {
/**
@constructor
@see {@link http://www.backbonejs.org/#Collection}
@augments Backbone.Collection
*/
var QueueCollection = Backbone.Collection.extend(/** @lends module:collections/queue~QueueCollection.prototype */{
/**
The model for this collection
@see {@link http://backbonejs.org/#Collection-model|Backbone docs}
@type module:models/entry
*/
model: EntryModel,
/**
The API for requests
@see {@link http://backbonejs.org/#Collection-url}
*/
url: '/queues',
/**
* @description Constructor called on class initialization
*/
initialize: function(){
},
});
// Required, return the module for AMD compliance
return QueueCollection;
});