Wie dokumentiere ich AMD + Backbone-Projekt mit JSDoc3

ich ein Backbone boilerplate basiertes Projekt haben, dass ich kürzlich mit jdoc-toolkit Wie dokumentiere ich AMD + Backbone-Projekt mit JSDoc3

dokumentieren wollen Obwohl ich nicht bekommen kann es alles andere als leer _global Klasse zu generieren

Codebeispiel:

/** 
* 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) { 

    },

Quelle

2013-03-01 Max The Cat

Sie können eine schrecklich hilfreich Vorschlag dies nicht berücksichtigen, aber Sie können zu prüfen, dass Sie alle gewinnen konnte oder fast alle gewünschten Vorteile von nur JSDoc mit der Art und Weise Sie bereits sind, und nie Dokumentationsdateien zu erzeugen. Ihre Entwickler sollten perfekt in der Lage sein, die Dokumentation in .js-Dateien zu lesen, ohne dass generiertes HTML benötigt wird, und damit würden Sie das Problem in dieser Frage vollständig vermeiden. – machineghost

Versuchen Sie, die @namespace Hinzufügen JSDoc wissen zu lassen, durch den Inhalt des Moduls zu suchen. Und definieren Sie Ihr Modul und seine Funktionen mit @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) { 

     },

Quelle

2013-05-10 18:28:43 sweetamylase

Wie dokumentiere ich AMD + Backbone-Projekt mit JSDoc3

Antwort

Verwandte Themen