PHP လုပ်ဆောင်ချက်များကိုထိရောက်သောစာရွက်စာတမ်းများရေးရန်မည်သို့ရေးရမည်နည်း။
Clear PHP function documentation ကိုရေးသားခြင်းသည်အရည်အသွေးမြင့်ကုဒ်၏အဓိကအစိတ်အပိုင်းဖြစ်သည်။ ထိရောက်သောစာရွက်စာတမ်းများသည် developer များကိုလျင်မြန်စွာလုပ်ဆောင်မှုများကိုလျင်မြန်စွာနားလည်နိုင်စေရန်, အမှားနှုန်းကိုလျှော့ချပြီးကုဒ်ထိန်းသိမ်းထားမှုကိုတိုးတက်စေနိုင်သည်။
PHP မှတ်ချက် Syntax
PHP သည် DocBlock မှတ်ချက်ရေးခြင်း syntax ကို function ကိုထည့်သွင်းရန် Syntax ကိုအသုံးပြုသည်။ DocBlock မှတ်ချက်ကို function definition မတိုင်မှီထားသင့်ပြီးတိကျသောပုံစံသည်အောက်ပါအတိုင်းဖြစ်သည် -
/ **
* နံပါတ်နှစ်ခု၏ပေါင်းလဒ်တွက်ချက်။
* @param int $ တစ်ခုပထမ ဦး ဆုံးနံပါတ်
* @param int ကို $ ခဒုတိယနံပါတ်
* @return int နံပါတ်နှစ်ခု၏ပေါင်းလဒ်
*
function ကိုထည့်ပေါင်းခြင်း (INT $ a, INT $ ခ): int {
$ a + $ b ကိုပြန်သွားပါ။
}
လိုအပ်သောစာရွက်စာတမ်းဒြပ်စင်
မှန်ကန်သောလုပ်ဆောင်ချက်စာရွက်စာတမ်းတွင်အနည်းဆုံးအောက်ပါတို့ပါ 0 င်သင့်သည် -
- ဖော်ပြချက် - function တစ်ခု၏ function ကိုဖော်ပြပါ။
- parameters တွေကို (@param) - parameter တစ်ခုချင်းစီနှင့်၎င်းတို့၏လုပ်ဆောင်ချက်များကိုစာရင်းပြုစုထားသည်။
- ပြန်လာတန်ဖိုး (@return): ပြန်လာတန်ဖိုး၏အမျိုးအစားနှင့်အဓိပ္ပာယ်ကိုရှင်းပြပါ။
- ခြွင်းချက် (@throws) - function ကိုပစ်ချနိုင်သည့်ခြွင်းချက်များကိုဖော်ပြသည်။
အကြံပြုစာရွက်စာတမ်းဒြပ်စင်
ထို့အပြင်အောက်ပါဒြပ်စင်များသည်အလွန်အထောက်အကူပြုသည် -
- ဥပမာ @Example (@Example) - developer များပိုမိုနားလည်ရန် Function အသုံးပြုမှုကိုပိုမိုနားလည်အောင်ကူညီရန် function function ကိုဥပမာပေးသည်။
- သမိုင်း (@Stance) - တံဆိပ်ကပ်ခြင်းလုပ်ဆောင်ချက်သည်မည်သည့် PHP ဗားရှင်းတွင်ပထမဆုံးအကြိမ်ဖြစ်သည်။
- စာရေးသူ (@author) - နောက်ပိုင်းပြုပြင်ထိန်းသိမ်းမှုအဆင်ပြေစေရန် function ကိုဖန်တီးသူများကိုစာရင်းပြုစုထားသည်။
လက်တွေ့ကျသောဥပမာများ
ဤတွင်အမှန်တကယ်စာရွက်စာတမ်းများဥပမာဖြစ်သည်။
/ **
* PHP ၏ datetime အရာဝတ်ထု format ။
* @param dateTime $ ရက်စွဲသည် format လုပ်ရန်
* @param String $ format output ကို format string ကို
* @return string ကို format ချိန်းချက် string ကို string ကို
* @throws သည် $ format ကိုမထောက်ပံ့ပါ
*
fatchdate function (datetime $ ရက်စွဲ, string ကို $ format): string ကို {
if (! Preg_match ('/ ^ [A-ZA-Z0-9 _] +', $ format))
လွဲချော်မှုအမှတ်အသားအသစ် ('မမှန်ကန်သော format string') ။
}
$ ရက်စွဲ -> ပုံစံ ($ format) ကိုပြန်ပို့ပါ။
}
အကျဉ်းချုပ်
ဤဆောင်းပါးတွင်ဖော်ပြထားသောမှတ်စုများကိုလိုက်နာခြင်းဖြင့်သင်သည် PHP လုပ်ဆောင်ချက်များအတွက်ရှင်းရှင်းလင်းလင်းနှင့်အလွန်အမင်းထိန်းသိမ်းထားနိုင်သောစာရွက်စာတမ်းများကိုရေးနိုင်ပါသည်။ ၎င်းသည်အခြား developer များကသင်၏ကုဒ်ကိုလျင်မြန်စွာနားလည်ရန်သာမကကုဒ်၏အရည်အသွေးနှင့်စာဖတ်နိုင်မှုကိုတိုးတက်စေသည်။
