2016-12-01 5 views
7

मैं विजुअल स्टूडियो कोड में एक कोणीय 2/टाइपस्क्रिप्ट प्रोजेक्ट का निर्माण कर रहा हूं, और दृढ़ता से जेएसडीओसी टिप्पणी ब्लॉक जोड़ रहा हूं, लेकिन अब मैं जेएसडीओसी आउटपुट देखना चाहता हूं। मैं अपनी जेएसडीओसी पीढ़ी प्रणाली स्थापित और स्थापित कर सकता था, लेकिन वीएससी में सभी अच्छे जीयूआई समर्थन दिए जाने के कारण यह जेएसडीओसी से जेएसडीओसी को उत्पन्न करने और देखने में सक्षम होना उचित लगता है।मैं विजुअल स्टूडियो कोड में जेएससीओडी-जेनरेटेड दस्तावेज़ कैसे देखूं?

मेरा Google-Fu मुझे विफल कर रहा है; हर बार जब मैं "विजुअल स्टूडियो कोड के भीतर जेएसडीओसी आउटपुट जेनरेट करना चाहता हूं" तो मुझे जेएसडीओसी टिप्पणी ब्लॉक उत्पन्न करने के लिए प्लगइन मिलते हैं।

क्या विजुअल स्टूडियो कोड के भीतर जेएसडीओसी आउटपुट उत्पन्न करने और देखने के तरीके हैं?

+0

क्या आपने https://www.npmjs.com/package/tsdoc की जांच की है? – Digvijay

+0

या ... http://typedoc.org/api/ - टर्मिनल से क्या किया जा सकता है, यह करने के लिए प्रति कहने के लिए कोई एक्सटेंशन नहीं दिखता है ... – JGFMK

+0

सभी विधियों को देखने के लिए 'Ctrl + Shift + O' दबाएं और जब आप वहां कोई विधि चुनते हैं और विधि पर होवर करते हैं तो संबंधित JSDoc खुलता है। – Manubhargav

उत्तर

1

AFAIK वहाँ कोई समर्थन में बनाया गया है, लेकिन मैं इसे आवश्यक है, आप आसानी से कि उचित jsdoc आदेश चला जाएगा एक कार्य जोड़ सकते हैं के रूप में नहीं लगता। यदि यह आप "अपनी खुद की JSDoc पीढ़ी प्रणाली की स्थापना" से क्या मतलब है मैं नहीं जानता, लेकिन यह जल्दी से किया है:

  1. पहले टर्मिनल से jsdoc जनरेटर स्थापित: npm install -g jsdoc (यह मानते हुए आप Node.js है/एनपीएम)।
  2. तय करें, जो तर्क आप jsdoc के लिए की जरूरत है (http://usejsdoc.org/about-commandline.html देखें)
  3. एक कार्य सेट करें (उदाहरण के लिए मेनू से: कार्य -> ​​कॉन्फ़िगर कार्य) - https://code.visualstudio.com/Docs/editor/tasks अधिक जानकारी के लिए देखते हैं (आप भी एक कीबोर्ड शॉर्टकट जोड़ सकते हैं)
  4. जेनरेट किए गए एचटीएमएल पेज को अपने जेएसडॉक्स के साथ खोलें।
+0

धन्यवाद: सबसे अच्छा जवाब। –

1

जिस स्थान पर मैंने पाया है कि jsdocs बनाम बनाम उपयोगी है intellisense के लिए।

फिर vscode जब भी मैं कोशिश करते हैं और फ़ंक्शन को कॉल मुझे इस वर्णनात्मक jsdocs दिखाएगा मैं इस समारोह

/** 
* This squares a function 
* @param x takes this value and doubles it 
*/ 
function myAwesomeFunction(x: number) { 
    return x *x; 
} 

है कहो।

enter image description here

+0

अच्छी जानकारी, और मुझे वह पता था, लेकिन यह वास्तव में एक अलग प्रश्न का उत्तर है (जिसे मैं शायद किसी दिन पूछूंगा)। धन्यवाद! –

संबंधित मुद्दे