विजुअल स्टूडियो 2010 जावास्क्रिप्ट/jQuery प्रलेखन

Question

ठीक है, दो यहाँ सवाल:

1. वहाँ जे एस के लिए GhostDoc ऐसा कुछ है?
2. क्या कोई अच्छी मदद फ़ाइल जनरेटर हैं जो दस्तावेज उत्पन्न करने के लिए सी # और जेएस स्रोत फ़ाइलों का उपयोग कर सकते हैं? ऐसा लगता है कि SandCastle किसी वेब प्रोजेक्ट के साथ .proj फ़ाइलों के विपरीत वेब साइट का समर्थन नहीं करता है। और, जहां तक ​​मैं कह सकता हूं, प्राकृतिक डॉक्स दृश्य स्टूडियो शैली दस्तावेज़ीकरण का समर्थन नहीं करता है ... ताकि यह काम न करे।

मुझे लगता है कि मुझे यहां कुछ याद आ रही है। मैं बस विश्वास नहीं कर सकता कि वहां से लोग अपने जेएस को हाथ से टिप्पणी कर रहे हैं ... कुछ होना है, है ना?

मैंने उच्च और निम्न खोज की है। मैं एक अंतिम उपाय के रूप में पूछ रहा हूँ। कृपया मुझे बताएं कि मैं खोज में डूब गया हूं और इसके लिए आसान समाधान हैं! :-)

Answer 1

आपने इसे एक उदाहरण के रूप में दिया है (इसे उचित प्रश्न में रखना अच्छा होगा, शायद एक मोड आएगा और आपके लिए ऐसा करेगा, क्योंकि आप अपने प्रश्नों को संपादित करने में सक्षम होना चाहिए) और आप जानना चाहते हैं कि /// <summary> ब्लॉक को कोड के जावास्क्रिप्ट भाग में स्वचालित रूप से डाला जा सकता है, न केवल .cs फ़ाइलों में।

(function ($) { $.fn.helpfulTips = function (options) { 
    /// <summary> 
    /// Helpful Tips 
    /// </summary> 
    /// <param name="options">options</param> 
    /// <returns>jQuery</returns> 
    var defaults = { pointer: "#theArrow" }; 
    } 
}); 

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

Answer 2

आप आउटपुट जैसे जावाडॉक उत्पन्न करने के लिए YuiDoc का उपयोग कर सकते हैं। मैंने इसका इस्तेमाल किया है और यह उपलब्ध आउटपुट के साथ बहुत खुश था। आपको टिप्पणियों के लिए अपने प्रारूप का उपयोग करने की आवश्यकता है जो विजुअल स्टूडियो प्रारूप के समान नहीं है।

Answer 3

आप जोड़कर संदर्भ होना चाहिए सब js फ़ाइलों स्रोत में उपयोग किया जाएगा:

/// <reference path="jquery-1.4.2.min.js" /> 
/// <reference path="facebox.js" /> 

अपने जावास्क्रिप्ट फ़ाइल के शीर्ष। इस तरह, आप जावास्क्रिप्ट में इंटेलिजेंस प्राप्त कर सकते हैं।

एक आखिरी बात, कुछ जेएस ढांचे (उदाहरण के लिए jQuery) में intellisense के लिए a -vsdoc.js फ़ाइल है। आपको उन फाइलों को रखना होगा जहां आपकी मूल जेएस फाइलें रहती हैं; और उनके नाम मिलान होना चाहिए।

अगर आपके js फ़ाइलों का नाम "test.js" फिर अपने -vsdoc फ़ाइल नामित किया जाना चाहिए है: "टेस्ट vsdoc.js"

Answer 4

वहाँ आप के लिए उपयोग की इस सूची में कुछ भी है: https://stackoverflow.com/questions/1221413/what-tools-are-available-for-documenting-javascript?