11

現在、私は Backbone/Marionette をいじっていますが (質問はより一般的ですが)、アプリケーション全体に「メッセージを送信する」コードがたくさんあります。例として、次のようなものがあります。

 vent.on("search:start", function() {...});
 vent.trigger("search:start");

しかし、アプリケーション内で利用可能なメッセージ/呼び出しを追跡 (文書化) する良い方法がありません。

だから私の質問は: これを文書化する良い方法は何ですか (サブ/パブ)?

私は(見つけられませんでしたが)コメント(Javadocスタイル)を追加できるツールがあり、そこから多かれ少なかれ合理的なものを生成すると思います。

4

3 に答える 3

7

私のお勧めは、1 つの大きな signal.eventConstants を持つことです。パブリッシュまたはサブスクライブするものとしてサブスクライバーまたはパブリッシャーに配置される文字列のリストを保持することを唯一の目的とするオブジェクトです。

だから代わりに

vent.on("search:start", function() {...});
vent.trigger("search:start");

あなたはするだろう

vent.on(signals.eventConstants.searchStart, function() {...});
vent.trigger(signals.eventConstants.searchStart);

そうすれば、すべてのパブリッシュ/サブスクリプション ブロードキャスト トピックを確認できる中心的な場所が 1 つあります。また、それらの名前を変更したり、後でさらに追加したりする場合は、1 つの場所で確認できるため、同じブロードキャストを作成することはありません。

signal.eventConstants 内で、各シグナルの目的をコメントで文書化することもできます。

だからあなたは次のようなものを持っているでしょう

//This broadcast will fire when a search is started
于 2013-04-05T18:26:24.093 に答える
0

YUI Doc http://yui.github.com/yuidoc/と JS DOC https://code.google.com/p/jsdoc-toolkit/を使用できます。ドキュメントを参照して、ニーズに合ったものを確認してください。

于 2013-04-05T17:02:21.083 に答える
0

多分あなたはJS-Signalsを使うことができますか?

于 2013-04-05T17:37:55.943 に答える