9
Ich bin auf der Suche nach dem besten Weg, um meinen Code zu dokumentieren, aber ich finde nichts.AMD + Backbone + JSDoc3 besten Weg zu dokumentieren
Ich habe andere Themen sehen, einschließlich this, aber dort löst nicht alles mein Problem.
Ich habe so etwas wie dies:
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;
});
Ich brauche eine lesbare Dokumentation zu erzeugen, wobei Produkt und Produkte Klassen apears in die Modelle/Produkte Modul, aber ich habe das Modul klar und die Klassen getrennt.
Ich nehme an, es gibt jemanden, der dieses Problem durchgemacht hat.
Danke.
PD1: Ich habe wirklich andere Beiträge gelesen, ich versuche nicht, Fragen zu duplizieren.
PD2: Leider mein schlechtes Englisch: S
Diese Art zu fragen, ob Tools und Wege empfohlen werden, wird auf dieser Website als nicht zu den Themen gehörend betrachtet. Sehen Sie: http://StackOverflow.com/Help/on-Topic – mico
"Wir fühlen die besten Stack Overflow Fragen haben ein bisschen Quellcode in ihnen, aber wenn Ihre Frage in der Regel deckt ... [...] Software-Tools häufig verwendet von Programmierern, und ist ", Wy, du denkst, es ist aus Toppic? Ich frage nach der korrekten Verwendung eines Tools, das von Programmierern häufig verwendet wird. Ich bitte nicht um eine bessere Verwendung, ich frage nach der richtigen Verwendung. – Exos