2016-12-09 3 views
0

Как записывать функции внутри возврата? В этом примере мне нужно() задокументировать. Я попытался добавить @memberOf и @name, чтобы заставить его генерировать. Ничто не работает для меня.Как записывать функции внутри возврата?

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

Обновление Добавлено JSDoc комментарии к вершине, чтобы избежать путаницы.

+0

Возможный дубликат [JSDoc: Возвращение объекта структура] (HTTP: // stackoverflow.com/questions/28763257/jsdoc-return-object-structure) – Hitmands

ответ

0

JSDoc comments должна быть выше декларации, то return заявление должно быть объявлено с @returns {type} value (обратите внимание, что @return является синонимами)

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

Я пытаюсь задокументировать функцию внутри возврата - как обещание. Внешняя функция имела свой собственный комментарий jsdoc, но не включала ее в пример, чтобы сделать ее кратким. –

+0

Если вы возвращаете обещание, вы должны сделать: '@returns {Promise}'. – Hitmands

+0

Это не обещание. Я сказал, как обещание. См. Приведенный выше код. –

Смежные вопросы