မှတ်ချက်ပြောင်းလဲခြင်းတူးလ်ကို ပိတ်ဆို့ရန် VSCode JSDoc အလိုအလျောက်စာသား
JavaScript/TypeScript အတွက် @example tag ကို အသုံးပြု၍ JSDoc စာသားလိုင်းကွဲမှုများကို လျင်မြန်စွာဖြေရှင်းရန် အကူအညီပေးသည့်ကိရိယာ JSDoc သည် JavaScript အတွက် အစွမ်းထက်သော စာရွက်စာတမ်းထုတ်ပေးသည့် ဂျင်နရေတာတစ်ခုဖြစ်သည်။ သင့်ကုဒ်အတွက် အသေးစိတ် API စာရွက်စာတမ်းများကို ဖန်တီးရန် အထူးဖော်မတ်ထားသော မှတ်ချက်များကို အသုံးပြုသည်။ သင်၏ JavaScript ဖိုင်များသို့ JSDoc မှတ်ချက်များထည့်ခြင်းဖြင့်၊ သင်သည် သင်၏လုပ်ဆောင်ချက်များ၊ အတန်းများနှင့် မော်ဂျူးများအကြောင်း ရှင်းလင်းပြီး ဖွဲ့စည်းတည်ဆောက်ထားသည့် အချက်အလက်ကို ပေးနိုင်ပါသည်။
JSDoc ၏ အဓိကအင်္ဂါရပ်များ
အချက်အလက်ကို ရိုက်ထည့်ပါ။
လုပ်ဆောင်ချက် ဘောင်များ နှင့် တန်ဖိုးများ ပြန်ပေးသည်။
အတန်းနှင့် နည်းလမ်းဖော်ပြချက်
မော်ဂျူးစာရွက်စာတမ်း
JSDoc တွင် အထူးအသုံးဝင်သော tag တစ်ခုမှာ @example tag ဖြစ်သည်။ ဤတက်ဂ်သည် သင့်စာရွက်စာတမ်းတွင် ကုဒ်နမူနာများ ထည့်သွင်းနိုင်စေပါသည်။ ကျွန်ုပ်တို့၏တူးလ်ကို သီးခြားသတ်မှတ်ထားသောအရာမှာ @example တဂ်အတွင်း ဖော်မတ်ချခြင်း၊ အင်တင်းတင်ခြင်းနှင့် လိုင်းခွဲခြင်းတို့ကို ထိန်းသိမ်းထားနိုင်ခြင်းဖြစ်သည်။ ဆိုလိုသည်မှာ သင်သည် ပိုမိုဖတ်ရလွယ်ကူပြီး လက်တွေ့ကျသော ကုဒ်နမူနာများကို ရေးနိုင်သောကြောင့် developer များအတွက် သင့်လုပ်ဆောင်ချက်များ သို့မဟုတ် အတန်းများကို အသုံးပြုပုံကို နားလည်ရန် ပိုမိုလွယ်ကူစေသည်။
အသုံးပြုပုံ ဥပမာ- /**
* Calculates the sum of two numbers.
* @param {number} a - The first number.
* @param {number} b - The second number.
* @returns {number} The sum of a and b.
* @example
* // This example preserves formatting and line breaks
* const result = add(5, 3);
* console.log(result);
* // Output: 8
*/
function add(a, b) {
return a + b;
} ကျွန်ုပ်တို့၏အွန်လိုင်း JSDoc မှတ်ချက်ပေးစက်ကိုအသုံးပြုခြင်းဖြင့်၊ သင်၏ကုဒ်နမူနာများတွင် ထိန်းသိမ်းထားသောဖော်မတ်ချခြင်းပါဝင်သည့် ကောင်းမွန်သောပုံစံဖြင့် စာရွက်စာတမ်းများကို အလွယ်တကူဖန်တီးနိုင်ပြီး၊ သင်၏ JavaScript စာရွက်စာတမ်းကို ပိုမိုရှင်းလင်းထိရောက်စေပါသည်။