我如何用文件AMD JSDoc3 +骨干工程 [英] How do I document AMD + Backbone project with JSDoc3

问题描述

我有一个骨干样板基础的项目，我想最近的 jdoc的工具包

虽然我不能让它产生任何东西，但空_global类

code样品：<​​/ P>

  / **
 *这是一个DLClass根模型
 * @module型号/ DLClass
 * /
定义（[
    下划线，
    '骨干'
]，/ ** @lends DLClass * /功能（_，骨干）{
    / **
     *这是一个DLClass根模型
     * @class DLClass
     * @constructor
     * @返回Session对象
     * /
    VAR DLModel = Backbone.Model.extend（{
        / ** @lends DLClass.prototype * /    / **
     *通用自来水事件
     * @参数的TouchEvent
     * /
    中的onTap：功能（的TouchEvent）{    }，
 

解决方案

尝试添加 @namespace 让JSDoc知道通过模块的内容看。并定义模块，将其使用功能的 @name 。

  / **
 *这是一个DLClass根模型
 * @module型号/ DLClass
 * @namespace
 * /
定义（[
    下划线，
    '骨干'
]，/ ** @lends DLClass * /功能（_，骨干）{
    / **
     *这是一个DLClass根模型
     * @class DLClass
     * @module型号/ DLClass
     * @name DLClass
     * @constructor
     * @返回Session对象
     * /
    VAR DLModel = Backbone.Model.extend（{
        / ** @lends DLClass.prototype * /        / **
         *通用自来水事件
         * @name DLClass.onTap
         * @function
         * @参数的TouchEvent
         * /
        中的onTap：功能（的TouchEvent）{        }，
 

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

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

Code sample:

/**
 * 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) {

    },

解决方案

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) {

        },

这篇关于我如何用文件AMD JSDoc3 +骨干工程的文章就介绍到这了，希望我们推荐的答案对大家有所帮助，也希望大家多多支持IT屋！