टाइपस्क्रिप्ट टिप्पणियों के लिए वाक्यविन्यास कहाँ प्रलेखित है?

Question

टाइपस्क्रिप्ट टिप्पणियों के लिए वाक्यविन्यास कहीं भी प्रलेखित है?

और किसी भी संयोग से, क्या यह अब C # ///सिस्टम का समर्थन करता है ?

Answer 1

सही सिंटैक्स अब TSDoc द्वारा उपयोग किया जाने वाला एक है । यह आपको विजुअल स्टूडियो कोड या अन्य प्रलेखन टूल द्वारा आपकी टिप्पणियों को समझने की अनुमति देगा।

वाक्य रचना का एक अच्छा अवलोकन यहाँ और विशेष रूप से यहाँ उपलब्ध है । सटीक कल्पना "जल्द" लिखी जानी चाहिए ।

एक और फ़ाइल की जाँच करने के लायक है यह वह जगह है जहाँ आपको उपयोगी मानक टैग दिखाई देंगे।

नोट : आपको JSDoc का उपयोग नहीं करना चाहिए, जैसा कि TSDoc मुख्य पृष्ठ पर बताया गया है: JSDoc मानक क्यों नहीं हो सकता है? दुर्भाग्य से, JSDoc व्याकरण को कड़ाई से निर्दिष्ट नहीं किया गया है, बल्कि एक विशेष कार्यान्वयन के व्यवहार से अनुमान लगाया गया है। अधिकांश मानक JSDoc टैग सादे जावास्क्रिप्ट के लिए प्रकार एनोटेशन प्रदान करने के साथ व्यस्त हैं, जो कि टाइपस्क्रिप्ट जैसी जोरदार टाइप की गई भाषा के लिए एक अप्रासंगिक चिंता है। TSDoc लक्ष्यों की अधिक परिष्कृत सेट से निपटने के दौरान इन सीमाओं को संबोधित करता है।

Answer 2

भविष्य

टाइपस्क्रिप्ट टीम, और अन्य टाइपस्क्रिप्ट शामिल टीम, एक मानक औपचारिक TSDoc विनिर्देश बनाने की योजना बनाते हैं। 1.0.0मसौदा अभी तक अंतिम रूप नहीं दिया गया है: https://github.com/Microsoft/tsdoc#where-are-we-on-the-roadmap

वर्तमान

टाइपस्क्रिप्ट JSDoc का उपयोग करता है। जैसे

/** This is a description of the foo function. */
function foo() {
}

Jsdoc सीखने के लिए: https://jsdoc.app/

लेकिन आपको JSDoc में एनोटेशन एक्सटेंशन टाइप करने की आवश्यकता नहीं है।

आप (और चाहिए) अभी भी अन्य jsdoc उपयोग कर सकते हैं ब्लॉक टैग की तरह @returnsआदि

उदाहरण

बस एक उदाहरण है। प्रकार (सामग्री नहीं) पर ध्यान दें।

JSDoc संस्करण (डॉक्स में सूचना प्रकार):

/**
 * Returns the sum of a and b
 * @param {number} a
 * @param {number} b
 * @returns {number}
 */
function sum(a, b) {
    return a + b;
}

टाइपस्क्रिप्ट संस्करण (नोटिस प्रकार के पुन: स्थान):

/**
 * Takes two numbers and returns their sum
 * @param a first input to sum
 * @param b second input to sum
 * @returns sum of a and b
 */
function sum(a: number, b: number): number {
    return a + b;
}

Comments

जैसा कि बास कहते हैं! उपयोग की एक अच्छी मिसाल के लिए निश्चित रूप से देखे गए jQuery.d.ts की जाँच करें

— John Reilly

जो निश्चित रूप से @JohnnyReilly द्वारा jsdoc'ed मिला है! :) github.com/borisyankov/DefinitelyTyped/blame/master/jquery/…

— basarat

यह एक अच्छा "सर्वश्रेष्ठ उत्तर" नहीं है क्योंकि यह मापदंडों, गुणों और वापसी मूल्यों की व्याख्या नहीं करता है।

— पिरान्हा

अपडेट किया गया लिंक: github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/…

— Aknosis

यह अब तक नहीं है। नीचे अद्यतन जवाब देखें।

— Qortex

Answer 3

आप मापदंडों, रिटर्न, आदि के बारे में जानकारी जोड़ सकते हैं:

/**
* This is the foo function
* @param bar This is the bar parameter
* @returns returns a string version of bar
*/
function foo(bar: number): string {
    return bar.toString()
}

यह वी.एस. कोड जैसे संपादकों को निम्नलिखित के रूप में प्रदर्शित करने का कारण बनेगा:

Comments

क्या आप VSCODE में इसके लिए शॉर्टकट कुंजी जानते हैं

— jet_choong

यदि आप टाइप करना शुरू करते हैं, तो फ़ंक्शन के ऊपर एक लाइन पर /**दबाएं tab, बनाम-कोड आपको मापदंडों के साथ JSDoc टिप्पणी भरने में सहायता करता है

— शार्पिरो

Answer 4

आप नियमित जावास्क्रिप्ट की तरह टिप्पणियों का उपयोग कर सकते हैं:

टाइपस्क्रिप्ट सिंटेक्स, इकास्मार्क 5 (ES5) सिंटैक्स का एक सुपरसेट है। [...]

यह दस्तावेज़ टाइपस्क्रिप्ट द्वारा जोड़ा गया सिंटैक्टिक व्याकरण का वर्णन करता है

इसके अलावा, मुझे केवल भाषा स्पेक्स में टिप्पणियों के बारे में यह पता चला:

टाइपस्क्रिप्ट भी जावास्क्रिप्ट प्रोग्रामर को वैकल्पिक प्रकार एनोटेशन की एक प्रणाली प्रदान करता है । ये प्रकार एनोटेशन क्लोज सिस्टम में पाए जाने वाले JSDoc टिप्पणियों की तरह हैं, लेकिन टाइपस्क्रिप्ट में वे सीधे भाषा वाक्य रचना में एकीकृत होते हैं। यह एकीकरण कोड को अधिक पठनीय बनाता है और उनके संबंधित चर के साथ प्रकार एनोटेशन को सिंक्रनाइज़ करने की रखरखाव लागत को कम करता है।

11.1.1 स्रोत फ़ाइलें निर्भरता:

प्रपत्र की एक टिप्पणी /// <reference path="..."/>पथ तर्क में निर्दिष्ट स्रोत फ़ाइल पर निर्भरता को जोड़ती है। पथ युक्त स्रोत फ़ाइल की निर्देशिका के सापेक्ष हल किया गया है

स्रोत:
https://github.com/Microsoft/TypeScript/blob/master/doc/spec.md

Comments

स्रोत लिंक टूट गया है

— पावलो

इसे GitHub के स्पेक्स सोर्स के लिंक के साथ बदला गया। वर्ड और पीडीएफ दस्तावेजों के रूप में भी उपलब्ध है: github.com/Microsoft/TypeScript/tree/master/doc

— CodeManX

Answer 5

TypeScript जावास्क्रिप्ट का एक सख्त वाक्यविन्यास सुपरसेट है इसलिए

• एकल पंक्ति टिप्पणियाँ // से शुरू होती हैं
• बहु-पंक्ति टिप्पणियाँ / * से शुरू होती हैं और * / के साथ समाप्त होती हैं