私のコードを文書化する最良の方法を探していますが、何も見つかりません。AMD + Backbone + JSDoc3を文書化する最良の方法
私はthisを含む他のトピックを参照していますが、すべて問題を解決できません。
私はこのようなものがあります:私は読みやすい文書を生成する必要が
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;
});
、製品と製品クラスはモデルにapears /製品モジュールを、私は明確なモジュールを取得しますクラスを別々にします。
この問題を抱えている人がいると思います。
ありがとうございました。
PD1:私は実際に他の投稿を読んでいますが、私は質問を複製しようとしていません。
PD2:私の下手な英語申し訳ありません:私は理解して
/**
* @module models/products
*/
:このdocを読んだ後S
このツールや方法を推薦するためのこの方法は、このサイトでは話題にならないと考えられています。 Look:http://stackoverflow.com/help/on-topic – mico
"私たちは最高のスタックオーバーフローの質問には、ソースコードのビットがあると思うが、あなたの質問が一般的にカバーしている場合... [...] 一般的に使用されるソフトウェアツールプログラマによって、そして、 "あなたはそれがタップを外していると思いますか?私は、 "一般的に使用されるプログラマー"ツールの正しい使い方を尋ねています。私はより良い使用を求めていない、私は正しい使用を求める。 – Exos