2015-05-11 3 views
0

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

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

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

    } 
} 
+0

До сих пор единственным способом, которым я получил это, является использование '@memberof controller: my_controller'. любые другие варианты? – user584569

ответ

0

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

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

+0

Можете ли вы поделиться своей конфигурацией, может быть? –