एक पाउंड/हैश संकेत

Question

इस सवाल के साथ जावास्क्रिप्ट उदाहरण के तरीकों की चर्चा करते हुए के लिए Why are methods in Ruby documentation preceded by a hash sign?

मैं समझता हूँ कि रूबी उदाहरण के तरीकों में क्यों एक पाउंड चिह्न के साथ रवाना हुए कर रहे हैं इसी तरह की है SomeObject.someMethod से SomeClass#someMethod के बारे में बात करने के लिए और rdoc की इजाजत दी अंतर करने के लिए मदद कर रहा काम। और मैं समझता हूं कि प्रोटोटाइपजेएस के लेखक रूबी (अच्छे कारण से) प्रशंसा करते हैं और इसलिए वे hash mark convention in their documentation का उपयोग करते हैं।

मेरा प्रश्न है: क्या यह जावास्क्रिप्ट डेवलपर्स के बीच एक मानक अभ्यास है या क्या यह प्रोटोटाइप डेवलपर्स है जो ऐसा करते हैं?

एक और तरीके से पूछा गया, क्या मेरे लिए टिप्पणियों/दस्तावेज़ीकरण में उदाहरण विधियों को SomeClass#someMethod के रूप में संदर्भित करना उचित है? या मेरा दस्तावेज `` SomeClass.someMethod` 'का संदर्भ लेना चाहिए?

Answer 1

मुझे लगता है कि यह जावाडोक से आता है।

http://java.sun.com/j2se/1.5.0/docs/tooldocs/windows/javadoc.html# {@link}

Answer 2

नहीं, मैं अभी तक एक और जावास्क्रिप्ट परियोजना इस अंकन का उपयोग करता है नहीं मिले हैं।

इस तरह की कुछ जावास्क्रिप्ट में उपयोगी है, हालांकि, कई भाषाओं में Class.methodName के विपरीत String.fromCharCode जैसे वर्गमार्गों का उल्लेख किया जाएगा, उदाहरण के तरीकों से नहीं, जो आप अक्सर बात करते हैं। myinstance.methodName द्वारा लागू विधि MyClass.methodName नहीं होगी लेकिन MyClass.prototype.methodName, और MyClass.prototype टाइपिंग रखने के लिए एक परेशानी है।

(मानक जे एस पुस्तकालय इस कई उदाहरण तरीकों में भी एक इसी classmethod है बनाकर confuses। लेकिन वे विभिन्न कार्यों कर रहे हैं।)

है यह मेरे में टिप्पणी/प्रलेखन उदाहरण तरीकों का उल्लेख करने के लिए के लिए proepr कुछ क्लास # कुछ विधि के रूप में?

जो आप सबसे ज्यादा पठनीय/ढूंढते हैं उसे करें। यहां कोई मानक नहीं है।