9
Kodumu belgelemenin en iyi yolunu arıyorum, ancak hiçbir şey bulamıyorum.AMD + Backbone + JSDoc3 belgelendirmenin en iyi yolu
this dahil olmak üzere başka konuları da gördüm, ancak hepsi sorunumu çözmüyor.
Böyle bir şey var: Ben okunaklı belgeleri oluşturmak gerekir
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;
});
, Ürün ve Ürünler sınıfları modellere apears/ürünler modül, ama net bir modül olsun ve sınıflar ayrı.
Sanırım bu konudan geçen biri var.
Teşekkürler.
PD1: Gerçekten başka yazılar okuyorum, soruları çoğaltmaya çalışmıyorum.
PD2: Benim kötü İngilizce Üzgünüm: Anlıyorum
/**
* @module models/products
*/
: Bu doc okuduktan sonra S
Araçları ve yolları önerme yöntemini sormanın bu yolu, bu sitede konu dışı kabul edilir. Bakın: http://stackoverflow.com/help/on-topic – mico
"En iyi Yığın Taşması sorularının kendilerine kaynak kodunun biraz geldiğini düşünüyoruz, ancak sorunuz genel olarak ele alındığında ... [...] yaygın olarak kullanılan yazılım araçları programcılar tarafından ve "," diyorsun. "Programcılar tarafından yaygın olarak kullanılan" aracının doğru kullanımını istiyorum. Daha iyi bir kullanım için sormuyorum, doğru kullanım için rica ediyorum. – Exos