Документирование модуля марионеток с RequireJS и JSDoc3

Question

У меня наконец-то есть время, чтобы официально документировать мой код Марионетки, но я сталкиваюсь с некоторыми проблемами с модулями JSDoc3 и Marionette.

Как бы идти о документировании модуля марионеток, определенном как это:

//Module1.js 
define([... , 'views'], function(..., 'views'){ 
    "usestrict"; 

    //Marionette Module definition: 
    return function(...marionette module params...){ 
     ... 
    } 
} 

, а затем подключить его в документации к виду определенный, как это:

//views.js 
define([...], function(...){ 
    "usestrict"; 

    var itemView = Marionette.ItemView.extend({ 
     ... 
    }; 

    //Uses itemView in a region 
    return Marionette.Layout.extend({ 
     ... 
     //do stuff with itemView 
     ... 
    }); 
} 

?

Спасибо!

Answer 1

Хорошо, спасибо Луи, я понял, как получить модуль для распознавания. Тогда я смог обходиться с ним достаточно, чтобы получить представление, зарегистрированное как класс для модуля.

Module1.js:

/** @module Module1 */ 
define([... , 'views'], function(..., 'views'){ 
    "usestrict"; 

    /** @lends module:Module1 */ 

    //Marionette Module definition: 
    return function(...marionette module params...){ 
     ... 
    } 
} 

и View.js:

define([...], function(...){ 
    "usestrict"; 

    /** 
    * @name module:Module1.Module1/Views/itemView 
    * @constructor 
    */ 
    var itemView = Marionette.ItemView.extend(
    /** @lends module:Module1.Module1/Views/itemView.prototype */ 
    { 
     ... 
    }; 

    /** 
    * @name module:Module1.Module1/Views/layoutView 
    * @constructor 
    */ 
    return Marionette.Layout.extend(
    /** @lends module:Module1.Module1/Views/layoutView.prototype */ 
    { 
     ... 
     //do stuff with itemView 
     ... 
    }); 
} 

Несколько примечаний:

• В @name взглядов, то .Module1/на самом деле не требуется, но это облегчает поиск на веб-странице doc.
• i temView технически является приватным в этом примере, так как он не возвращается, но я хочу, чтобы его можно было найти в документах.