サブ/パブを文書化するにはどうすればよいですか？

Question

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

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

しかし、私は、アプリケーション内で使用可能なメッセージ/通話（文書）を追跡するために何か良い方法はありません。

私の質問です。これを文書化するにはどうすればよいですか（サブ/パブ）？

（私は見つけませんでしたが）コメント（Javadocスタイル）を追加できるツールがあるかもしれませんが、多かれ少なかれ妥当なものが生成されます。

Answer 1

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

Answer 2

たぶん、あなたは一つの大きなsignals.eventConstantsを持っているだろうJS-Signals?

Answer 3

私の推薦を使用することができます。これは、出版または購読しているものとして購読者または出版社に配置される文字列のリストを保持することを唯一の目的としているオブジェクトです。

ので、代わりの

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

をやってあなたは

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

を行うだろうそして、あなたはすべてのあなたのパブリッシュ/サブスクリプション放送のトピックをチェックすることができる一つの中央の場所を持っている、そして、あなたが変更したい場合それらの名前、または後で追加する場合は、チェックする場所が1つありますので、同じブロードキャストを作成しないでください。

signals.eventConstantsの中には、各信号の目的をコメントで記録することもできます。

ですから、

//This broadcast will fire when a search is started