টাইপস্ক্রিপ্ট মন্তব্যগুলির জন্য সিনট্যাক্স নথিভুক্ত কোথায়?

Question

টাইপস্ক্রিপ্ট মন্তব্যের জন্য সিনট্যাক্সটি কোথাও নথিভুক্ত করা হয়েছে?

এবং যে কোনও সুযোগে, এটি এখন সি # ///সিস্টেমকে সমর্থন করে ?

Answer 1

ডান সিনট্যাক্স এখন টিএসডোক দ্বারা ব্যবহৃত একটি । এটি আপনাকে ভিজুয়াল স্টুডিও কোড বা অন্যান্য ডকুমেন্টেশন সরঞ্জামগুলির দ্বারা আপনার মন্তব্যগুলি বোঝার অনুমতি দেবে।

সিনট্যাক্সের একটি ভাল ওভারভিউ এখানে এবং বিশেষত এখানে উপলভ্য । সুনির্দিষ্ট স্পেসটি "শীঘ্রই" লেখা উচিত ।

অন্য ফাইলটি যাচাইয়ের জন্য গুরুত্বপূর্ণ এটি হ'ল এটি যেখানে আপনি দরকারী স্ট্যান্ডার্ড ট্যাগগুলি দেখতে পাবেন।

দ্রষ্টব্য : আপনার জেএসডোক ব্যবহার করা উচিত নয়, যেমন টিএসডোকের মূল পৃষ্ঠায় ব্যাখ্যা করা হয়েছে: জেএসডক কেন মানক হতে পারে না? দুর্ভাগ্যক্রমে, জেএসডোক ব্যাকরণটি কঠোরভাবে নির্দিষ্ট করা হয়নি বরং একটি নির্দিষ্ট বাস্তবায়নের আচরণ থেকে অনুমান করা হয়েছে। বেশিরভাগ স্ট্যান্ডার্ড জেএসডোক ট্যাগ সরল জাভাস্ক্রিপ্টের জন্য টাইপ টিকা প্রদানের সাথে জড়িত, যা টাইপস্ক্রিপ্টের মতো দৃ strongly়ভাবে টাইপিত ভাষার জন্য অপ্রাসঙ্গিক উদ্বেগ। TSDoc লক্ষ্যগুলি আরও পরিশীলিত সেট মোকাবেলা করার সময় এই সীমাবদ্ধতাগুলিকে সম্বোধন করে।

Answer 2

ভবিষ্যৎ

টাইপস্ক্রিপ্ট দল এবং অন্যান্য টাইপস্ক্রিপ্ট জড়িত দলগুলি একটি স্ট্যান্ডার্ড আনুষ্ঠানিক টিএসডোক স্পেসিফিকেশন তৈরি করার পরিকল্পনা করে। 1.0.0খসড়াটি এখনও চূড়ান্ত হয়নি: https://github.com/Mic Microsoft/tsdoc#where-are-we-on- the- roadmap

বর্তমান

টাইপস্ক্রিপ্ট জেএসডোক ব্যবহার করে। যেমন

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

Jsdoc শিখতে: https://jsdoc.app/

তবে আপনাকে জেএসডোকে প্রকারের টীকা টিকা এক্সটেনশন ব্যবহার করার দরকার নেই।

আপনি (এবং উচিত) এখনো অন্যান্য jsdoc ব্যবহার করতে পারেন ব্লক ট্যাগ মত @returnsইত্যাদি

উদাহরণ

শুধু একটি উদাহরণ। প্রকারগুলিতে (বিষয়বস্তু নয়) ফোকাস করুন।

জেএসডোক সংস্করণ (ডক্সে নোটিশের ধরণ):

/**
 * 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 দেখুন

— জন রিলি

অবশ্যই অবশ্যই জনি রেলি দ্বারা জসডোক 'পেয়েছেন! :) github.com/borisyankov/DefinitelyTypeed/blame/master/jquery/…

— বাসরাত

এটি কোনও ভাল "সেরা উত্তর" নয় কারণ এটি প্যারামিটার, বৈশিষ্ট্য এবং ফেরতের মানগুলি ব্যাখ্যা করে না।

— পিরানহা

আপডেট হওয়া লিঙ্ক: github.com/DefinitelyTypeed/DefinitelyTypeed/tree/master/tyype/…

— আকনোসিস

এটি এখন আর আপ টু ডেট নেই। নীচে আপডেট উত্তর দেখুন।

— কোর্টেক্স

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

আপনি কি ভিসকোডিতে এর জন্য শর্টকাট কীটি জানেন

— jet_choong

আপনি যদি টাইপিং শুরু করেন /**তবে tabফাংশনের উপরে একটি লাইন টিপুন , বনাম-কোড আপনাকে প্যারামিটারগুলি দিয়ে

— জেএসডকের

Answer 4

আপনি নিয়মিত জাভাস্ক্রিপ্ট এর মত মন্তব্য ব্যবহার করতে পারেন:

টাইপস্ক্রিপ্ট সিনট্যাক্স হ'ল ইকমাস্ক্রিপ্ট 5 (ইএস 5) সিনট্যাক্সের একটি সুপারসেট। [...]

এই নথিটি টাইপস্ক্রিপ্ট দ্বারা যুক্ত সিনট্যাকটিক ব্যাকরণ বর্ণনা করে

তা ছাড়া, আমি কেবলমাত্র ভাষা স্পেসে মন্তব্যগুলি সম্পর্কে এটি পেয়েছি:

টাইপস্ক্রিপ্ট জাভাস্ক্রিপ্ট প্রোগ্রামারগুলিকে optionচ্ছিক প্রকারের টিকাশনের একটি সিস্টেম সরবরাহ করে । এই ধরণের টীকাগুলি বন্ধ সিস্টেমটিতে পাওয়া জেএসডক মন্তব্যের মতো, তবে টাইপস্ক্রিপ্টে এগুলি সরাসরি ভাষার বাক্য বিন্যাসে সংহত হয়। এই সংহতকরণটি কোডটিকে আরও পঠনযোগ্য করে তোলে এবং তাদের সম্পর্কিত ভেরিয়েবলগুলির সাথে টাইপ টোটাল সিঙ্ক্রোনাইজ করার রক্ষণাবেক্ষণ ব্যয় হ্রাস করে।

১১.১.১ উত্স ফাইল নির্ভরতা:

ফর্মের একটি মন্তব্য /// <reference path="..."/>পথ আর্গুমেন্টে উল্লিখিত উত্স ফাইলের উপর নির্ভরতা যুক্ত করে। সম্বলিত উত্স ফাইলের ডিরেক্টরি সম্পর্কিত পথটি সমাধান করা হয়েছে

সূত্র: https://github.com/Mic Microsoft/ TypeScript/ blob/ master/ doc/
spec.md

Comments

উত্স লিঙ্কটি নষ্ট হয়ে গেছে।

— পাভলো

এটি গিটহাবের চশমা উত্সের লিঙ্ক দিয়ে প্রতিস্থাপন করেছে। ওয়ার্ড এবং পিডিএফ ডকুমেন্ট হিসাবেও উপলব্ধ: github.com/Mic Microsoft

— TypeScript

Answer 5

টাইপস্ক্রিপ্ট তাই জাভাস্ক্রিপ্টের একটি কঠোর সিনট্যাকটিক্যাল সুপারসেট

• একক লাইন মন্তব্য // দিয়ে শুরু
• মাল্টি-লাইন মন্তব্যগুলি / * দিয়ে শুরু হয় এবং * / দিয়ে শেষ হয়