क्या javascript ऑब्जेक्ट और तरीकों

Question

मैं (जो मैं जानता हूँ से) एटलस है जहां वरीय करने के लिए इस्तेमाल कर रहा हूँ विधि जैसे एक्सएमएल टिप्पणियों का उपयोग करने के लिए है टिप्पणी की पसंदीदा तरीका है:

/// <summary> 
/// Method to calculate distance between two points 
/// </summary> 
/// 
/// <param name="pointA">First point</param> 
/// <param name="pointB">Second point</param> 
/// 
function calculatePointDistance(pointA, pointB) { ... } 

हाल ही में मैं किया गया है अन्य 3 पार्टी जावास्क्रिप्ट लाइब्रेरियों में देख और मैं वाक्य रचना की तरह देखें:

/* 
* some comment here 
* another comment here 
* ... 
*/ 
function blahblah() { ... } 

एक बोनस के रूप में, मुझे पता है अगर वहाँ जावास्क्रिप्ट कि 'पसंदीदा' टिप्पणी शैली पढ़ सकता है के लिए किसी भी API जनरेटर रखते हैं।

Answer 1

है JSDoc

/** 
* Shape is an abstract base class. It is defined simply 
* to have something to inherit from for geometric 
* subclasses 
* @constructor 
*/ 
function Shape(color){ 
this.color = color; 
} 

Answer 2

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

दूसरा उदाहरण सी स्टाइल ब्लॉक टिप्पणी का उपयोग करता है जो एकाधिक लाइनों या लाइन के बीच में टिप्पणी करने की अनुमति देता है।

Answer 3

दृश्य स्टूडियो 08 में एक जावास्क्रिप्ट फ़ाइल में निम्न चिपकाकर प्रयास करें और इसके साथ चारों ओर खेलने:

var Namespace = {}; 
    Namespace.AnotherNamespace = {}; 

Namespace.AnotherNamespace.annoyingAlert = function(_message) 
{ 
    /// <param name="_message">The message you want alerted two times</param> 
    /// <summary>This is really annoying!!</summary> 

    alert(_message); 
    alert(_message); 
}; 

Intellisense बहुतायत!

इस बारे में अधिक जानकारी (बाहरी पुस्तकालयों में उपयोग के लिए बाहरी जावास्क्रिप्ट-फाइलों को संदर्भित करने के तरीके सहित) Scott Gu's blog पर पाया जा सकता है।

Answer 4

याहू YUIDoc प्रदान करता है।

यह अच्छी तरह से प्रलेखित है, याहू द्वारा समर्थित है, और यह एक नोड.जेएस ऐप है।

यह भी एक ही वाक्यविन्यास का उपयोग करता है, इसलिए एक से दूसरे में जाने के लिए कई बदलाव नहीं किए जाने चाहिए।

Answer 5

सरल सबसे अच्छा, टिप्पणियाँ अच्छे हैं, यह :)

var something = 10; // My comment 

/* 
Lorem ipsum dolor sit amet, consectetur adipisicing elit, 
sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. 
Ut enim ad minim veniam, quis nostrud exercitation ullamco 
nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor 
in reprehenderit in voluptate velit esse cillum dolore eu 
fugiat nulla pariatur. 
*/ 

function bigThing() { 
    // ... 
} 

का उपयोग करता है लेकिन स्वत: जनरेट दस्तावेज़ के लिए ...

/** 
* Adds two numbers. 
* @param {number} num1 The first number to add. 
* @param {number} num2 The second number to add. 
* @return {number} The result of adding num1 and num2. 
*/ 
function bigThing() { 
    // ... 
}