JSDoc - 如何记录原型对象的方法

时间:2015-06-17 09:30:30

标签: javascript documentation jsdoc jsdoc3

基于我对JSDoc中命名继承的理解,这应该可以定义@name User.format#name,但它不会

/**
 * @class
 * @classdesc Stores the logged in user's information. Handles user updates and includes helper
 * methods for formatting users
 */
User = function() {};

/**
 * Object containing utility methods for formatting user objects
 *
 * @name User.format
 * @property {object}
 */
User.prototype.format = {
    /**
     * returns the full name of a user
     *
     * @name User.format#name
     * @param {User} user
     * @returns {string} the full name
     */
    name: function(user) {
        // some utility function
    }
};

0 个答案:

没有答案