9
Szukam najlepszego sposobu na udokumentowanie mojego kodu, ale niczego nie znajduję.AMD + Backbone + JSDoc3 najlepszy sposób na dokumentację
Widziałem inne tematy, w tym this, ale tam wszystko nie rozwiązuje mojego problemu.
mam coś takiego:
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;
});
muszę wygenerować czytelną dokumentację, gdzie wyrobów i Produkty klas apears w modelach /Produkty modułu, ale pojawia się moduł jasną i klasy przez osobne.
Przypuszczam, że jest ktoś, kto przeszedł przez ten problem.
Dzięki.
PD1: Naprawdę czytam inne posty, nie próbuję duplikować pytań.
PD2: Przepraszam mój biedny angielski: S
Ten sposób prośby o rekomendowanie narzędzi i sposobów jest uważany za nietypowy na tej stronie. Look: http://stackoverflow.com/help/on-topic – mico
"Czujemy, że najlepsze pytania dotyczące przepełnienia stosu mają w sobie trochę kodu źródłowego, ale jeśli twoje pytanie obejmuje ogólnie ... [...] powszechnie używane narzędzia programowe przez programistów i jest ", Wy myśli, że to nie jest toppic? Pytam o poprawne użycie narzędzia "powszechnie używanego przez programistów". Nie proszę o lepsze wykorzystanie, proszę o poprawne użycie. – Exos