Comment နဲ့ Document ဆိုတာ developer တွေအားလုံး code ရေးတဲ့အခါနေ့စဉ်ထိတွေ့နေရတဲ့အရာတွေပဲဖြစ်လို့ ဒီနှစ်ခုကို ကွဲကွဲပြားပြားသိထားသင့်ပါတယ်။

Comment ဆိုတာက ကျွန်တော်တို့ရေးထားတဲ့ code တွေကို ပြန်ဖတ်တဲ့အခါ မှတ်မိစေဖို့ အမှတ်သားအနေနဲ့ရေးထားတဲ့ အချက်အလက်တွေပဲဖြစ်ပါတယ်။ ကျွန်တော်တို့ code တွေကို လက်ဆင့်ကမ်းတဲ့အခါမျိုးမှာလည်း နောက်ထပ် developer တွေအတွက် နားလည်စေဖို့ဖြစ်ဖြစ် မှတ်သားရေးခဲ့ကြပါတယ်။ comment တွေရေးတဲ့အခါ ဘယ်လိုဘယ်ပုံရေးရမယ်ဆိုပြီး language တစ်ခုကနေသတ်မှတ်ထားတဲ့စံနှုန်းတွေမရှိဘဲ အဆင်ပြေသလို‌ရေးမှတ်ကြပါတယ်။

 

Document ဆိုတာကတော့ ကျွန်တော်တို့ကိုနားလည်စေဖို့အတွက် programming language တွေကနေသတ်‌မှတ်ပေးထားတဲ့စာညွှန်းတွေပဲဖြစ်ပါတယ်။ ကျွန်တော်တို့ဟာ code ရေးရင်းမသိတာတွေကို အင်တာနက်ပေါ်မှာ မျှဝေထားကြတဲ့စာတွေဖြစ်ဖြစ် code editor မှာပဲ mouse hover လုပ်ပြီးပဲဖြစ်ဖြစ် ဖတ်လေ့ရှိကြပါတယ်။ ဒါတွေကိုတော့ document လို့ခေါ်ပါတယ်။ ဒါအပြင် ကျွန်တော်တို့ ကိုယ်တိုင်လည်း document တွေပြင်ဆင်လို့ရပါသေးတယ်။

ဥပမာ - function တစ်ခုကိုရေးထားတယ်ဆိုပါစို့။ အဲ့ function ကို ပြန်ခေါ်သုံးတဲ့အခါ အဲ့နေရာမှာပဲ mouse လေးတင်လိုက်တာနဲ့ ဒီ function ကဘာ parameter လိုသလဲ၊ ဘာတွေ return ပြန်ထားတယ်ဆိုတာကို မူလရေးထားတဲ့နေရာကိုပြန်သွားကြည့်စရာမလိုအောင် အဲ့ function နဲ့ပတ်သတ်တဲ့ document ကိုရေးထားခဲ့လို့ရပါတယ်။ document တွေကိုတော့ သတ်မှတ်ထားတဲ့ rule အတိုင်းဖန်တီးရပါတယ်။

ကဲ ဒါဆိုရင်တော့ comment & documentation ကိုကွဲကွဲပြားပြားသိသွားလောက်ပြီပေါ့‌နော်...