Alt/pub'ı belgelemek için iyi bir yol nedir? (Soru daha genel olsa)

Question

Şu anda Omurga/Marionette uğraşırken ediyorum ve her uygulamada üzerinde "mesajı göndererek" bu kodu bir sürü var. Sadece böyle bir örnek, bir şey olarak:

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

Ama mesajları/çağrılar bir uygulama içinden hangi (belge) izini herhangi iyi bir yol yoktur.

Benim soru şudur: Bu (alt/pub) belgelemek için iyi bir yolu nedir?

Varsayalım ki (bir tane bulamadım), yorum eklemenize izin verecek bir araç olabilir (Javadoc stili), ve daha fazla veya daha az makul bir şey üretecektir.

Answer 1

Sen YUI Doc http://yui.github.com/yuidoc/ ve JS DOC https://code.google.com/p/jsdoc-toolkit/ kullanabilirsiniz. İhtiyaçlarınıza uygun olanı görmek için belgelere bakın.

Answer 2

Belki bir büyük signals.eventConstants sahip olacaktır JS-Signals?

Answer 3

Benim öneri kullanabilirsiniz. Bu tek amacı var bir nesne yayınlamadan veya abone olduğunuz şey olarak abone veya yayıncı içine yerleştirilen olsun dizeleri listesini tutmaktır bu.

Bunun yerine

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

yapmanın Sen yapacağını Sonra

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

sahip değiştirmek istediğiniz takdirde tüm yayımlamak/abonelik yayın konular için kontrol VE bir merkez yer Bunların adını veya daha sonra ekleyin, aynı yayınları oluşturmamanız için kontrol etmeniz gereken tek bir yeriniz var.

signals.eventConstants İçi da yorumlarla her sinyalin amacını belgelemek olabilir.

Yani

//This broadcast will fire when a search is started