Как получить тег @borrows, работающий в JSDoc

Question

Мне было трудно получить тег @borrows, работающий в JSDoc. Я пытаюсь получить документацию из одной функции, и мы ее как документацию для второй функции. Но я, похоже, не могу даже получить простой пример работы!

/** 
* This is the description for funcA 
*/ 
var funcA = function() {}; 

/** 
* @borrows funcA as funcB 
*/ 
var funcB = function() {}; 

Я ожидал, что это будет выводить документацию для обеих функций с точно такой же. Однако только funcA имеет только описание.

Буду признателен за помощь, я чувствую, что я не понимаю некоторые основные понятия JSBin. Пожалуйста, расскажите мне, что я новичок в JSDoc, и, похоже, не очень подробная документация.

Answer 1

Тэг @borrows не работает непосредственно на символ, но только косвенно. Например, у меня было:

/** does amazing things */ 
function origFunc = function() {}; 

/** 
* @borrows origFunc as exportedFunc 
*/ 
exports.exportedFunc = origFunc; 

но я, как и вы, не получил ничего полезного в созданном документе.

То, что, кажется, что тег @borrows работает на контейнере . (Если вы заметите в примерах @borrows тег на «Util» модуль/пространство имен, а не переименованы символ.)

Так что это работает для меня:

/** does amazing things */ 
function origFunc = function() {}; 

/** 
* @borrows origFunc as exportedFunc 
*/ 
exports = { 
    exportedFunc: origFunc, 
} 

Похоже ошибка в @borrows. (Или, по крайней мере, ошибка в документации.)