如何记录闭包函数

3

我想记录一个名为User的类中的功能,该类位于闭包内部 - 我如何使用JsDoc3实现这一点?

以下是我的代码:

/**
    @class User
    @classdesc This is the class that describes each user.
*/
(function($){

    var _defaults = {
        'first_name': '',
        'last_name': ''
    };

    /**
        @constructor
    */
    function User(options) {
        this.options = $.extend({}, _defaults, options);
    }

    /**
        @method
        @desc Returns the combined first name and last name as a string
        @returns {string}
    */
    User.prototype.getName() = function(){
        return this.options.first_name + this.options.last_name;
    };

    window.User = User;

}(jQuery));
3个回答

2
我用这种方法成功了(添加到一个样板插件中,因此包括MIT许可证注释)。
请注意@global + @class的使用以及原型上的@global。 看起来就是这样。
以下是复制的代码: 享受并使其更好。
/**
* jQuery lightweight plugin boilerplate
* Original author: @ajpiano
* Further changes, comments: @addyosmani
* Licensed under the MIT license
*/

;(function ( $, window, document, undefined ) {

var pluginName = "Application",
    defaults = {
        propertyName: "value"
    };

/**
 * @global
 * @class Application
 * @description MASTER:  Sets up and controls the application
 * 
 * @returns Object
 */
function Application( element, options ) {
    this.element = element;
    this.options = $.extend( {}, defaults, options) ;
    this._defaults = defaults;
    this._name = pluginName;
    this.init();
     window[pluginName] = this;
}

/** @global */
Application.prototype = {

    /**
    * @description call pre-life initialisations and tests here
    */
    init: function() {

        var that = this;
       that._build();
       that._setNotifications();
    },

    /**
    @description Set up a pub sub for global notifications such a state-changes.
    */
    _setNotifications: function(el, options) {
        console.log('Application=>setNotifications()');
    },


    /**
    @description All environment setup done we now call other plugins.
    */
    _build: function(el, options) {
        console.log('Application=>build()');
    }
};

$.fn[pluginName] =  function ( options ) {
    return this.each(function () {
        if (!$.data(this, "plugin_" + pluginName)) {
            $.data(this, "plugin_" + pluginName,
            new Application( this, options ));
        }
    });
};




})( jQuery, window, document );

1

我不知道为什么jsdoc3决定忽略闭包内的文档,但至少有一个解决方法是使用@memberOf标签来明确告诉哪个类一个方法属于:

/**
 * @memberOf User
 * Returns the combined first name and last name as a string
 * @returns {string}
 */
User.prototype.getName = function(){

另外需要注意的是,您不需要使用@desc@classdesc标签 - 这些标签由jsduc3自动添加,这些标签存在只是一种实现细节。

0
在我的情况下,闭包在单个文件中,并使用字典导出其对象,因此在概述中使用@file和@exports DicName标签以及在字典中使用@namespace标签可以使它们得到记录。
/**
    @file myFileWithClosure
    @exports DicName
*/
(function($){

    /** @namespace */
    DicName = {};

    ...

不需要全局变量。


网页内容由stack overflow 提供, 点击上面的
可以查看英文原文,
原文链接