Comments
Comments ဆိုတာက Program ေရးေနရင္းနဲ႔ Program ထဲမွာပဲ Program နဲ႔ပတ္သက္တဲ႔ ရွင္းၿပခ်က္တို႔၊ Programmer အခ်င္းခ်င္း ေရွ႔လူလုပ္တာကို ေနာက္လူသိေအာင္ ဘာ႔ေၾကာင္႔ဒီလိုေရးပါတယ္ဆိုတာ ခ်ိတ္ဆက္မိေအာင္...၊ ကိုယ္ေရးတာကိုပဲ ေနာက္တစ္ခါၿပန္အၾကည္႔မွာ ဘာေၾကာင္႔ဒီလိုေရးထားတယ္ဆိုတာသိေအာင္ ေရးတဲ႔ေနရာမွာ သံုးပါတယ္..။ Program ကိုထိေရာက္မွဳမရွိေစပါဘူး..။ ဘယ္နွစ္ေၾကာင္းေရးေရး Program ကိုထိေရာက္မွဳမရွိေစခ်င္ရင္..၊ ကိုယ္ေရးတဲ႔ကုဒ္က သိပ္မေသခ်ာရင္ comment ပိတ္ထားခဲ႔ရင္ အဲဒီကုဒ္က Program ကို သက္ေရာက္မွဳမရွိေစေတာ႔ပါဘူး..။
ကိုယ္ေရးတဲ႔စာက တစ္ေၾကာင္းတည္းဆိုရင္၊ ဒါမွမဟုတ္ တစ္ေၾကာင္းၿပီးတစ္ေၾကာင္း line by line ဆိုရင္ (//)မ်ဥ္းနွစ္ေၾကာင္းနဲ႔ တစ္ေၾကာင္းခ်င္းေရွ႕ကေန ပိတ္သြားရပါတယ္..။
ကိုယ္ေရးတဲ႔ Comment က တစ္ေၾကာင္းထက္ပိုတယ္..၊ စာတစ္ပုိဒ္ေလာက္ရွည္တယ္ဆိုရင္လည္း ဘယ္နွစ္ေၾကာင္းပဲၿဖစ္ေနေန အစမွာ (/*) နဲ႔ အဆံုးမွာ (*/)အဲလိုပိတ္ေပးရပါတယ္..။ ၾကားထဲမွာ စာဘယ္နွစ္ေၾကာင္းရွိရွိ အစမွာတစ္ခါနဲ႔ အဆံုးမွာ တစ္ခါပဲ စေပး၊ ပိတ္ေပးလိုက္ရံုပါပဲ..။
ေနာက္တစ္မ်ိဴးက documentation comment ဆိုတာ ရွိေသးတယ္..။ XML file ေတြကို comment ပိတ္တယ္ဆိုရင္ သူတို႔က file အမ်ိဴးအစားေတြမို႔ documentation comment နဲ႔ပိတ္ရတယ္..။ tag အစကေန line by line စာေၾကာင္းဆံုးသေလာက္ တစ္ေၾကာင္းခ်င္းေရွ႔မွာပိတ္သြားရမယ္..။
No comments:
Post a Comment