Что такое хороший способ документировать суб-паб?

В настоящее время я играю с Backbone/Marionette (хотя вопрос более общий), и у меня есть много кода, который "отправляет сообщения" по всему приложению. Как пример, что-то вроде этого:

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

Но у меня нет хорошего способа отследить (документ), какие сообщения/вызовы доступны в приложении.

Итак, мой вопрос: что такое хороший способ документировать это (sub/pub)?

Я бы предположил (хотя я его не нашел) может быть инструмент, который позволит вам добавлять комментарии (стиль Javadoc), и он будет генерировать что-то более или менее разумное из него.

Ответ 1

Моя рекомендация состояла бы в том, чтобы иметь один большой signal.eventConstants. Это цель, единственная цель которой состоит в том, чтобы содержать список строк, которые помещаются в подписчик или издатель, как вещь, которую вы публикуете или подписываете.

Итак, вместо того, чтобы делать

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

Вы бы сделали

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

Затем у вас есть одно центральное место, где вы можете проверить все ваши темы публикации/подписки, и если вы хотите изменить их имя или добавить более позднее, у вас есть одно место для проверки, чтобы вы не создавали идентичные трансляции.

Внутри сигналов .eventConstants вы также можете документировать назначение каждого сигнала с комментариями.

Итак, у вас есть что-то вроде

//This broadcast will fire when a search is started

Ответ 2

Вы можете использовать YUI Doc http://yui.github.com/yuidoc/ и JS DOC https://code.google.com/p/jsdoc-toolkit/. Посмотрите на документацию, чтобы узнать, что соответствует вашим потребностям.

Ответ 3

Возможно, вы могли бы использовать JS-Signals?