1

Каков правильный способ добавления документации jsdoc для модуля, который использует свободное увеличение? Или я просто неправильно настраиваю свою реализацию? В конечном итоге я ожидаю, что мои общие члены будут включены в мою окончательную документацию.JSDoc со свободным модулем расширения не разбирает некоторые элементы

Я пытаюсь использовать JSdoc в модуле, который я создал с помощью свободной модели расширения (as described here). Модуль по линиям:

/** 
* @module awesomeModuleToDocument 
* @description This module will make you awesome when setup and parsed correctly. 
*/ 
var awseomeModuleToDocument = (function() { 

var _moduleReturnObject = {}; 

/** 
* These awesome things are not shared but do get parsed as expected. 
* @alias module:awesomeModuleToDocument.privateThingsThatAreAwesome 
* @readonly 
* @enum 
*/ 
var privateThingsThatAreAwesome = { 
    /** 0 */ 
    'Unicorns' : 0, 
    /** 1 */ 
    'Bigfoot' : 1 
}; 

/** 
* These awesome things are shared but do not get parsed as expected. 
* @alias module:awesomeModuleToDocument.publicThingsThatAreAwesome 
* @readonly 
* @enum 
*/ 
_moduleReturnObject.publicThingsThatAreAwesome = { 
    /** 0 */ 
    'Beards' : 0, 
    /** 1 */ 
    'Goats' : 1, 
    /** 2 */ 
    'GoatBeards' : 2, 
}; 

    return _moduleReturnObject; 

}(awseomeModuleToDocument || {})); 

Однако, когда я бегу JSDoc на этом коде, я получаю выход, который включает в себя privateThingsThatAreAwesome, но не публичную версию. Кроме того, если я вытащил тег @alias для частного перечисления, я тоже не вижу его в выходе.

Мое предположение заключается в том, что я не правильно использую тег @alias в общедоступном случае, но ряд тестов и поисков не дал мне ниоткуда.

Мой выход для JSDoc 3.4.3 является: Not awesome JSDOC output

ответ

1

Игра вокруг с этим немного больше, добавив тег @memberof, казалось, дать мне ожидаемые результаты документации:

/** 
* These awesome things are now parsing as I expected. 
* @memberof module:awesomeModuleToDocument 
* @alias module:awesomeModuleToDocument.publicThingsThatAreAwesome 
* @readonly 
* @enum 
*/ 
_moduleReturnObject.publicThingsThatAreAwesome = {...} 

Однако Я предполагаю, что по-прежнему существует «более предпочтительный» способ обойти это.

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

  • Нет связанных вопросов^_^