记录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文档http://yui.github.com/yuidoc/和JS DOC https://code.google.com/p/jsdoc-toolkit/。查看文档，了解哪些内容符合您的需求。

Answer 3

也许你可以使用JS-Signals?