HTML comment ေတြကေတာ့ ကိုယ္ကိုတိုင္အတြက္၊ တျခား Web Developer ေတြအတြက္၊ ကိုယ့္ရဲ႕ Source Code ကို ဝင္ၾကည့္တဲ့ Visitor ေတြအတြက္ Note လိုပါပဲ။ PHP comment ေတြကေတာ့ php file ကို Browser ကေန View Source လုပ္ပီးၾကည့္လဲ ျမင္ရပါဖူး။ PHP source file ကို ဖြင့္ၾကည့္မွပဲ ျမင္ရမွာပါ။ HTML comment ရဲ႕ syntax ကို ေမ့ေနရင္ ေအာက္မွာ ျပန္ၾကည့္ပါ။

<!-- This is an HTML Comment -->

PHP Comment Syntax: Single Line Comment

HTML မွာ comment type တစ္မ်ိဳးပဲရွိေပမယ့္ PHP မွာေတာ့ ႏွစ္မ်ိဳးရွိပါတယ္။ ပထမ တစ္မ်ိဳးကေတာ့ Single Line comment ပါ။ Single Line comment အတြက္ “//” ကို သံုးပါတယ္။ Code line တစ္လိုင္းထဲမွာ “//” ရဲ႕ ညာဖက္က စာသားအားလံုးကို Interpreter က ေက်ာ္သြားပါမယ္။

Example:

<?php
echo "Hello World!"; // This will print out Hello World!
echo "<br />How? Can you see my comment?"; // echo "nothing";
// echo "My name's Goo Goo!";
?>

Output:

Hello World!
How? Can you see my comment?

echo line ေတြကို comment လုပ္လိုက္တဲ့ အတြက္ execute မလုပ္ေတာ့ပါဖူး။ ဒီ Single Line comment ကို နားလည္ရခက္တဲ့ line ေတြမွာ quick note သေဘာမ်ိဳးသံုးႏိုင္ပါတယ္။ ေနာက္ၿပီး code line တစ္လိုင္းကို တစ္ခါထဲ ဖ်က္မပစ္ဘဲ ယာယီသေဘာ ခဏ ဖယ္ထားခ်င္တဲ့ အခါမ်ိဳးမွာလဲ အသံုးတဲ့ပါတယ္။
PHP Comment Syntax: Multiple Line Comment

Multiple Line comment ေတြကိုေတာ့ code line ေတြ အမ်ားႀကီးကို ခဏဖယ္ထားရာမွာ (သို႔) line အမ်ားႀကီး Note ေရးခ်င္တဲ့ အခါမွာသံုးပါတယ္။ Multiple Line comment ကို “/*” နဲ႔ စၿပီး “*/” နဲ႔ ျပန္ပိတ္ေပးရပါမယ္။

Example:

<?php
/* This Echo statement will print out my greeting message to the
place in which I reside on. In other words, the World. */
echo "Hello World!";
/* echo "My name is Doo Doo!";
echo "No way! My name's Goo Goo, the stupid PHP Programmer!";
*/
?>

Output:

Hello World!

Good Commenting Practices

PHP programmer ေတြမွ မဟုတ္ပါဘူး။ Programmer တိုင္းကို comment ေတြကို သံုးျဖစ္ေအာင္ သံုးပါလို႔ က်ေနာ့္အေနနဲ႔ အၾကံေပးခ်င္ပါတယ္။ Programmer ေတာ္ေတာ္မ်ားမ်ားဟာ ရႈပ္ေထြးတဲ့ code ေတြ ေရးရမွာ မပ်င္းေပမယ့္၊ comment ေကာင္းေကာင္း ေရးဖို႔ကိုေတာ့ အပ်င္းထူတတ္ၾကပါတယ္။ Comment ေရးတာ အပိုအလုပ္လို႔လဲ ထင္တတ္ၾကပါတယ္။

ဒါေပမယ့္ ကိုယ္ကိုတိုင္ ေရးထားတဲ့ comment မပါတဲ့ code ေတြကိုပဲ တစ္ႏွစ္ေလာက္ ၾကာတဲ့ အခါမွာျပန္ၾကည့္လိုက္ပါ။ ကိုယ္ဘာအဓိပၸါယ္နဲ႔ ေရးထားတယ္ဆိုတာကို ကိုယ္ကိုတိုင္ မမွတ္မိေတာ့တာမ်ိဳးေတြ ျဖစ္တတ္ပါတယ္။ အခုေနာက္ပိုင္းမွာ တျခား Programmer ေတြနဲ႔ တြဲေရးရတာေတြပဲ မ်ားလာပါတယ္။ အဲေတာ့ ကိုယ့္ code ကို သူမ်ား အလြယ္တကူ နားလည္ႏိုင္ဖို႔ comment ေကာင္းေကာင္း ေရးတာ အက်င့္လုပ္ထားဖို႔ လိုအပ္ပါတယ္။ Single Line comment ေတြကို နည္းနည္း နားလည္ရခက္တဲ့ line ေတြမွာ ထည့္ေရးပါ။ အဲထက္ပိုပီး အေသးစိတ္ရမယ္ဆိုရင္ေတာ့ Multiple Line comment သံုးပီး Note အေနနဲ႔ ေရးေပးပါ။ အနာဂတ္မွာ Programmer ေကာင္း တစ္ေယာက္ ျဖစ္လာပါလိမ့္မယ္။