记录sub/pub的好方法是什么？

Question

目前我正在使用Backbone/Marionette(尽管问题更为通用),我有很多代码在整个应用程序中"发送消息".就像一个例子,这样的事情:

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

但我没有任何好的方法来跟踪(文档)应用程序中可用的消息/调用.

所以我的问题是:记录这个(sub/pub)的好方法是什么？

我会假设(虽然我没有找到)可能会有一个工具允许你添加注释(Javadoc样式),它会产生或多或少合理的东西.

Answer 1

我的建议是有一个很大的信号.eventConstants.这是一个对象,其唯一目的是保存一个字符串列表,这些字符串将作为您要发布或订阅的内容放入订阅者或发布者.

所以不要这样做

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

你会的

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

然后,您有一个中心位置,您可以检查所有发布/订阅广播主题,如果您想更改它们的名称,或稍后添加更多,您有一个地方需要检查,因此您不会创建相同的广播.

在signals.eventConstants内部,您还可以使用注释记录每个信号的用途.

所以你有类似的东西

//This broadcast will fire when a search is started

Answer 2

您可以使用 YUI Doc http://yui.github.com/yuidoc/和 JS DOC https://code.google.com/p/jsdoc-toolkit/。查看文档以了解哪些内容适合您的需求。