Warning: file_get_contents(/data/phpspider/zhask/data//catemap/0/backbone.js/2.json): failed to open stream: No such file or directory in /data/phpspider/zhask/libs/function.php on line 167

Warning: Invalid argument supplied for foreach() in /data/phpspider/zhask/libs/tag.function.php on line 1116

Notice: Undefined index: in /data/phpspider/zhask/libs/function.php on line 180

Warning: array_chunk() expects parameter 1 to be array, null given in /data/phpspider/zhask/libs/function.php on line 181
Javascript 记录sub/pub的好方法是什么?_Javascript_Backbone.js_Documentation_Marionette - Fatal编程技术网

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

Javascript 记录sub/pub的好方法是什么?,javascript,backbone.js,documentation,marionette,Javascript,Backbone.js,Documentation,Marionette,目前,我正在使用主干网/木偶网(虽然这个问题更一般),我有很多代码可以在应用程序中“发送消息”。举个例子,如下所示: vent.on("search:start", function() {...}); vent.trigger("search:start"); 但是我没有任何好的方法来跟踪(文档)应用程序中哪些消息/调用可用 所以我的问题是:什么是记录这个(sub/pub)的好方法 我想(虽然我没有找到)可能有一个工具可以让你添加评论(Javadoc风格),它会从中生成或多或少合理的东西

目前,我正在使用主干网/木偶网(虽然这个问题更一般),我有很多代码可以在应用程序中“发送消息”。举个例子,如下所示:

 vent.on("search:start", function() {...});
 vent.trigger("search:start");
但是我没有任何好的方法来跟踪(文档)应用程序中哪些消息/调用可用

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


我想(虽然我没有找到)可能有一个工具可以让你添加评论(Javadoc风格),它会从中生成或多或少合理的东西。

你可以使用YUI Doc和JS Doc。请查看文档,看看哪些适合您的需要。

也许您可以使用

我的建议是使用一个big signals.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

查看YUI文档-这是一个发布/订阅实现;OP要求提供关于如何记录可用订阅的建议。