расширение jsDoc для обработки пользовательских тегов

Я хочу расширить jsdoc (особенно с помощью docstrap). У меня есть приложение nodeJS, и я хочу разделить навигацию jsdoc на контроллеры, представления и т. Д. Мне удалось в определенной степени с этим справиться, создав свои собственные теги, такие как @controller, и удалось заставить его захватить JsDoc, аналогично @module, чтобы он генерировал страницу (с описанием). Однако моя проблема связана с функциями, связанными, например, с контроллером, которые расположены с функцией «module.exports». Созданная документация в основном игнорирует любые другие функции в этом файле @controller. Как я могу запечатлеть эти функции.

Ниже приведен пример этого:

/**
 * @controller my_controller
 */
module.exports = {
    /**
     * @description my function
     */
    myFn : function(){

    }
}

person user584569    schedule 11.05.2015    source источник
comment
пока что единственный способ заставить это работать - использовать @memberof controller:my_controller. любые другие варианты?   -  person user584569    schedule 11.05.2015


Ответы (1)


Что сработало для меня в аналогичном контексте, так это использование плагина, который эффективно помечает элемент как module, когда он помечен как controller. Таким образом, вы получаете поведение, подобное модулю, а затем при рендеринге модулей вы просто исключаете модели, представления и контроллеры.

Мне нужно исправить множество мест, чтобы заставить его работать, иначе некоторые поведения просто привязаны к modules, и наверху нет абстракции, которая позволила бы вам запускать те же поведения.

person SGD    schedule 19.05.2015
comment
может ты можешь поделиться своей конфигурацией? - person Ardit Meti; 09.02.2016