सब/पब दस्तावेज करने का एक अच्छा तरीका क्या है?

Question

वर्तमान में मैं बैकबोन/मैरियनेट के साथ खेल रहा हूं (हालांकि प्रश्न अधिक सामान्य है), और मेरे पास बहुत सारे कोड हैं जो पूरे एप्लिकेशन में "संदेश भेज रहे हैं"। बस एक उदाहरण है, कुछ इस तरह के रूप में:

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

लेकिन मैं (दस्तावेज़) को ट्रैक करने की जो संदेश/कॉल एक आवेदन के भीतर उपलब्ध हैं किसी भी अच्छा तरीका नहीं है।

तो मेरा सवाल है: इस (उप/पब) को दस्तावेज करने का एक अच्छा तरीका क्या है?

मुझे लगता है कि (हालांकि मुझे एक नहीं मिला) एक ऐसा उपकरण हो सकता है जो आपको टिप्पणियां (जावाडोक शैली) जोड़ने की अनुमति देगा, और इससे कुछ कम या ज्यादा उचित उत्पन्न होगा।

Answer 1

आप यूयूआई डॉक http://yui.github.com/yuidoc/ और जेएस डीओसी https://code.google.com/p/jsdoc-toolkit/ का उपयोग कर सकते हैं। यह देखने के लिए दस्तावेज देखें कि आपकी ज़रूरतों के अनुरूप क्या है।

Answer 2

शायद तुम इस्तेमाल कर सकते हैं JS-Signals?

Answer 3

मेरे सिफारिश एक बड़ा signals.eventConstants के लिए किया जाएगा। यह एक ऑब्जेक्ट है जिसका एकमात्र उद्देश्य है कि आप जिस चीज को प्रकाशित कर रहे हैं या सब्सक्राइब कर रहे हैं, उसके रूप में ग्राहक या प्रकाशक में रखे तारों की एक सूची रखना है।

बजाय

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

करने का आप क्या करना होगा

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

फिर

आपके पास एक केंद्रीय स्थान है जहां आप अपने सभी प्रकाशित/सदस्यता प्रसारण विषयों के लिए जाँच कर सकते हैं, और आप बदलना चाहते हैं उनका नाम, या बाद में जोड़ें, आपके पास जांच करने के लिए एक स्थान है ताकि आप समान प्रसारण न बनाएं।

सिग्नल के अंदर। इवेंट कॉन्स्टेंट्स आप टिप्पणी के साथ प्रत्येक सिग्नल के उद्देश्य को भी दस्तावेज कर सकते हैं।

तो तुम जैसे

//This broadcast will fire when a search is started