လွယ်လွယ်ပြောရရင် Clean Code ဆိုတာ ကွန်ပျူတာနားလည်ရုံတင်မဟုတ်ဘဲ လူလည်း ဖတ်လို့ကောင်း၊ နားလည်လွယ်တဲ့ Code ပါ။ Code က အလုပ်လုပ်တာချင်းအတူတူ၊ တစ်ခုက ဖတ်ရတာ ရှင်းပြီး နောက်တစ်ခုက ဖတ်ရတာ ခေါင်းကိုက်နေတယ်ဆိုရင် ပထမတစ်ခုက Clean Code ပါ။

ကျွန်တော် ဒါကို အခန်းရှင်းလင်းတာနဲ့ ဥပမာပေးချင်တယ်။ အခန်းနှစ်ခန်း ရှိတယ်ဆိုပါစို့။ ပထမအခန်းမှာ အဝတ်အစားတွေ၊ စာအုပ်တွေ၊ ကြိုးတွေ နေရာတကာ ပွနေတယ်။ တစ်ခုခု ရှာချင်ရင် ဟိုလှန် ဒီလှန်နဲ့ အချိန်ကုန်တယ်။ ဒုတိယအခန်းမှာတော့ အဝတ်က ဗီရိုထဲမှာ၊ စာအုပ်က စင်ပေါ်မှာ၊ ကြိုးက ဘူးထဲမှာ — တစ်ခုခု လိုရင် ချက်ချင်း တွေ့တယ်။ Code လည်း အဲဒီလိုပါပဲ။ ရှင်းလင်းတဲ့ Code ကို ပြင်ချင်ရင်၊ Bug ရှာချင်ရင် ချက်ချင်း တွေ့တယ်။ ရှုပ်နေတဲ့ Code ကျတော့ တစ်ခုပြင်ဖို့ တစ်နေကုန် ထိုင်ရှာနေရတတ်ပါတယ်။

Clean Code မဟုတ်တဲ့ Code က ဘယ်လိုပုံစံလဲ?

ကျွန်တော် အရင်က ရေးခဲ့ဖူးတဲ့ Code တွေထဲမှာ ဒီလို ပုံစံတွေ ရှိခဲ့တယ်။


def calc(x, y):
    z = x * 0.2
    return y - z

ဒီ Code က အလုပ်လုပ်ပါတယ်။ ဒါပေမယ့် x က ဘာလဲ၊ y က ဘာလဲ၊ 0.2 က ဘာလဲ ဆိုတာ ဘယ်သူမှ မသိဘူး။ တစ်လကြာရင် ကိုယ်တိုင်တောင် မေ့သွားတတ်ပါတယ်။

ဒီလိုရေးရင် ပိုရှင်းပါတယ်။


def apply_discount(price, discount_rate):
    discount_amount = price * discount_rate
    return price - discount_amount

ရှင်းပါတယ်။ နာမည်တွေက အဓိပ္ပာယ်ဖော်နေတယ်။ Code ကို ဖတ်လိုက်တာနဲ့ ဘာလုပ်နေလဲဆိုတာ သိတယ်။ ဒါက Clean Code ရဲ့ အခြေခံအကျဆုံး စည်းမျဉ်းပါ — နာမည်ကို အဓိပ္ပာယ်ရှိရှိ ပေးပါ။

Clean Code ရေးဖို့ စည်းမျဉ်း ၅ ချက်

၁။ နာမည်ကို အဓိပ္ပာယ်ရှိရှိ ပေးပါ။

x၊ data၊ temp လို နာမည်တွေအစား user_age၊ order_total၊ discount_rate လို နာမည်တွေ သုံးပါ။ Function နာမည်ကလည်း ဘာလုပ်လဲဆိုတာ ပြောနေရမယ်။ do_stuff() အစား send_welcome_email() လို့ ရေးပါ။

၂။ Function တစ်ခုက အလုပ်တစ်ခုပဲ လုပ်ပါ။

Function တစ်ခုထဲမှာ Email ပို့တာ၊ Database သိမ်းတာ၊ ငွေတွက်တာတွေ အားလုံး ရောထည့်မရေးပါနဲ့။ တစ်ခုချင်းစီကို သီးသန့် Function ခွဲပါ။ Function တစ်ခုက စာကြောင်း ၂၀ လောက် ကျော်သွားရင် ခွဲဖို့ စဉ်းစားပါ။

၃။ ဂဏန်းတွေ တိုက်ရိုက်မရေးပါနဲ့။

Code ထဲမှာ 0.2၊ 86400 လို ဂဏန်းတွေ တိုက်ရိုက်ရေးထားတာကို Magic Number လို့ ခေါ်ပါတယ်။ ဘာကိုဆိုလိုလဲဆိုတာ ဘယ်သူမှ မသိဘူး။ အဲဒီအစား နာမည်ပေးပြီး သိမ်းပါ။


DISCOUNT_RATE = 0.2
SECONDS_PER_DAY = 86400

၄။ ထပ်နေတဲ့ Code ကို မရေးပါနဲ့။

တူညီတဲ့ Code ကို နေရာသုံးခုမှာ ကူးရေးထားရင် ပြင်ရတဲ့အခါ သုံးနေရာလုံး လိုက်ပြင်ရတယ်။ တစ်နေရာကျန်ခဲ့ရင် Bug ဖြစ်တယ်။ ထပ်နေတာတွေကို Function တစ်ခုတည်း ထုတ်ပြီး ပြန်သုံးပါ။ ဒါကို DRY — Don’t Repeat Yourself လို့ ခေါ်ပါတယ်။

၅။ Comment ကို လိုအပ်တဲ့နေရာမှာပဲ ရေးပါ။

Code ကိုယ်တိုင်က ရှင်းနေရင် Comment မလိုပါဘူး။ “ဒီ Function က ဘာလို့ ဒီလိုလုပ်ရတာလဲ” ဆိုတဲ့ အကြောင်းပြချက်ကိုပဲ Comment ရေးပါ။ ဥပမာ “Bank API က ဒီနည်းနဲ့မှ အလုပ်လုပ်လို့ ဒီလို ရေးထားတယ်” ဆိုတာမျိုး။

Clean Code ဘာလို့ အရေးကြီးတာလဲ?

တချို့က “Code အလုပ်လုပ်ရင် ပြီးတာပဲ၊ ရှင်းရှင်းလင်းလင်း ရေးဖို့ ဘာလိုလဲ” လို့ ထင်တတ်ပါတယ်။ ဒါပေမယ့် လက်တွေ့မှာ Programmer တစ်ယောက်ရဲ့ အချိန်အများစုက Code ရေးနေတာမဟုတ်ဘူး — သူများ ရေးထားတဲ့ Code ကို ဖတ်နေတာပါ။ လေ့လာမှုတွေအရ Programmer တွေက အချိန် ၈၀% လောက်ကို Code ဖတ်တာနဲ့ ကုန်တယ်လို့ ဆိုပါတယ်။

ဒါ့အပြင် Clean Code မဟုတ်တဲ့ Project ကို အဖွဲ့ထဲ လူအသစ်ဝင်လာရင် သင်ပေးဖို့ အချိန်အများကြီး ကုန်တယ်။ Bug တစ်ခုကို ပြင်ဖို့ ရက်အတော်ကြာ ရှာရတယ်။ Feature အသစ်ထည့်ဖို့ ကြောက်နေရတယ် — တစ်ခုထိရင် တစ်ခုကျိုးမှာစိုးလို့။

Robert C. Martin (Uncle Bob) ရဲ့ “Clean Code” စာအုပ်မှာ ပြောထားသလိုပဲ — Code ကို စက်အတွက် ရေးတာမဟုတ်ဘူး၊ လူအတွက် ရေးတာပါ။ ကွန်ပျူတာက ဘယ်လိုရေးရေး နားလည်တယ်။ ဖတ်ရမယ့်သူက လူပါ။

ဒီနေ့ကစပြီး လုပ်နိုင်တာတွေ

Variable နာမည်ပေးတဲ့အခါ x၊ a အစား အဓိပ္ပာယ်ရှိတဲ့ နာမည် သုံးပါ။
Function တစ်ခုရေးပြီးတိုင်း “ဒီ Function က အလုပ်တစ်မျိုးတည်းပဲ လုပ်လား” လို့ ပြန်မေးပါ။
Code ကို Commit မလုပ်ခင် တစ်ခေါက်ပြန်ဖတ်ပြီး နာမည်တွေ ရှင်းလား စစ်ပါ။
Python ဆိုရင် Black လို Formatter နဲ့ Flake8 လို Linter ကို သုံးပါ။ စက်က အလိုလို ရှင်းပေးလိမ့်မယ်။
သူများ Project က Clean Code တွေကို ဖတ်ကြည့်ပါ။ Requests Library လို နာမည်ကြီး Project တွေရဲ့ Code က အကောင်းဆုံး ဆရာပါ။

Code ရှင်းလင်းတာက အလှအပအတွက် မဟုတ်ပါဘူး။ အနာဂတ်မှာ ကိုယ့်ကိုယ်ကို ကယ်တင်တာပါ။ ခြောက်လအကြာမှာ ကိုယ့် Code ကိုယ် ပြန်ဖတ်ရတဲ့အခါ “ဒါ ဘယ်သူ ရေးထားတာလဲ” လို့ မမေးရအောင် ဒီနေ့ကစပြီး ရှင်းရှင်းလင်းလင်း ရေးကြည့်ပါ။ 🙂

—

Avatar photo
Min SiThu
@itsmeminsithu

Software Engineer & Tech Content Creator

View all posts