如何使用 JSDoc3 记录 AMD + Backbone 项目

问题描述：

我有一个基于 Backbone 样板的项目，我想用最近的 jdoc-toolkit

I have a Backbone boilerplate based project, that I want to document with recent jdoc-toolkit

虽然除了空的 _global 类之外我无法让它生成任何东西

Though I can't get it to generate anything but empty _global class

代码示例:

/**
 * This is a root model for DLClass
 * @module models/DLClass
 */
define([
    'underscore',
    'backbone'
], /** @lends DLClass */ function (_, Backbone) {        
    /**
     * This is a root model for DLClass
     * @class DLClass
     * @constructor
     * @return Session Object
     */
    var DLModel = Backbone.Model.extend({
        /** @lends DLClass.prototype */

    /**
     * Generic tap event
     * @param touchEvent
     */
    onTap: function (touchEvent) {

    },

答

尝试添加 @namespace 以让 JSDoc 知道查看模块的内容.并使用 @name 定义您的模块及其功能.

Try adding the @namespace to let JSDoc know to look through the contents of the module. And define your module and it's functions using @name.

/** 
 * This is a root model for DLClass
 * @module models/DLClass
 * @namespace
 */
define([
    'underscore',
    'backbone'
], /** @lends DLClass */ function (_, Backbone) {        
    /**
     * This is a root model for DLClass
     * @class DLClass
     * @module models/DLClass
     * @name DLClass
     * @constructor
     * @return Session Object
     */
    var DLModel = Backbone.Model.extend({
        /** @lends DLClass.prototype */

        /**
         * Generic tap event
         * @name DLClass.onTap
         * @function
         * @param touchEvent
         */
        onTap: function (touchEvent) {

        },

如何使用 JSDoc3 记录 AMD + Backbone 项目

相关推荐