9
Sto cercando il modo migliore per documentare il mio codice, ma non trovo nulla.AMD + Backbone + JSDoc3 il modo migliore per documentare
Ho visto altri argomenti, tra cui this, ma non tutti risolvono il mio problema.
ho qualcosa di simile a questo:
define([
'backbone'
], function (Backbone) {
/**
* @module models/products
*/
/**
* Product model
* @class
*/
var Product = Backbone.Model.extend({
/** @lends Product.prototype */
/**
* Some method
* @param {String} name - Name of something
* @return {something}
*/
someMethod: function() {
// ...
}
});
/**
* Products collection
* @class
*/
var Products = Backbone.Collection.extend({
/** @lends Products.prototype */
/**
* @type {Product}
*/
model: Product,
/**
* Some method
* @param {String} name - Name of something
* @return {something}
*/
someMethod: function() {
// ...
}
});
return Products;
});
ho bisogno di generare una documentazione leggibile, dove prodotto e Prodotti classi apears nei modelli /prodotti modulo, ma ottengo il modulo chiaro e le classi da separati.
Suppongo che ci sia qualcuno che ha affrontato questo problema.
Grazie.
PD1: Ho letto davvero altri post, non sto cercando di duplicare le domande.
PD2: Scusate il mio povero inglese: S
Questo modo di chiedere consigli per gli strumenti e le modalità è considerato off-topic in questo sito. Guarda: http://stackoverflow.com/help/on-topic – mico
"Riteniamo che le migliori domande di Stack Overflow abbiano un po 'di codice sorgente in esse, ma se la tua domanda generalmente copre ... [...] strumenti software comunemente usati dai programmatori, ed è ", Wy pensi che sia toppic? Sto chiedendo l'uso corretto di uno strumento "comunemente usato dai programmatori". Non chiedo un uso migliore, chiedo l'uso corretto. – Exos