Comment documenter des fonctions dans un retour?

Question

Comment documenter des fonctions dans un retour? Dans cet exemple, j'ai besoin de() documenté. J'ai essayé d'ajouter @memberOf et @name pour le générer. Rien ne semble fonctionner pour moi.

/** 
* The description for the outer function 
* @param {string} test Example argument 
* @return {Object} 
*/ 
example.func = function(test) { 
    return { 
     /** 
     * The description for the inner "then" function 
     * @param {Function} cb The callback function 
     */ 
     then: function(cb) { } 
    } 
} 

Mise à jour Ajouté jsdoc commentaires vers le haut pour éviter toute confusion.

Answer 1

JSDoc comments doit être au-dessus de la déclaration, la déclaration return doit être déclarée avec @returns {type} value (notez que @return est un synonymes)

/** 
* Returns the sum of a and b 
* 
* @param {Number} a 
* @param {Number} [b = 0] 
* @returns {Number} 
*/ 
function sum(a, b = 0) { 
    return a + b; 
}