Come posso documentare AMD progetto + Backbone con JSDoc3

Ho un progetto Backbone boilerplate base, che voglio documentare con la recente jdoc-toolkit Come posso documentare AMD progetto + Backbone con JSDoc3

Anche se non posso farlo per generare qualche cosa ma di classe _global vuota

esempio di codice:

/** 
* This is a root model for DLClass 
* @module models/DLClass 
*/ 
define([ 
    'underscore', 
    'backbone' 
], /** @lends DLClass */ function (_, Backbone) {   
    /** 
    * This is a root model for DLClass 
    * @class DLClass 
    * @constructor 
    * @return Session Object 
    */ 
    var DLModel = Backbone.Model.extend({ 
     /** @lends DLClass.prototype */ 

    /** 
    * Generic tap event 
    * @param touchEvent 
    */ 
    onTap: function (touchEvent) { 

    },

fonte

2013-03-01 Max The Cat

L'utente non può considerare questo un suggerimento terribilmente utile, ma si può prendere in considerazione che si potrebbe ottenere tutti o quasi tutti i benefici desiderati semplicemente utilizzando JSDoc il modo in cui sei già, e non genera file di documentazione. I tuoi sviluppatori dovrebbero essere perfettamente in grado di leggere la documentazione all'interno dei file .js, senza bisogno di HTML generato, e così facendo eviterai completamente il problema in questa domanda. – machineghost

Provate ad aggiungere la @namespace per far JSDoc sapere di guardare attraverso il contenuto del modulo. E definisci il tuo modulo e le sue funzioni usando @name.

/** 
* This is a root model for DLClass 
* @module models/DLClass 
* @namespace 
*/ 
define([ 
    'underscore', 
    'backbone' 
], /** @lends DLClass */ function (_, Backbone) {   
    /** 
    * This is a root model for DLClass 
    * @class DLClass 
    * @module models/DLClass 
    * @name DLClass 
    * @constructor 
    * @return Session Object 
    */ 
    var DLModel = Backbone.Model.extend({ 
     /** @lends DLClass.prototype */ 

     /** 
     * Generic tap event 
     * @name DLClass.onTap 
     * @function 
     * @param touchEvent 
     */ 
     onTap: function (touchEvent) { 

     },

fonte

2013-05-10 18:28:43 sweetamylase

Come posso documentare AMD progetto + Backbone con JSDoc3

risposta

Problemi correlati