Dynamics 365 Business Central: Single-line vs Multi-line Comments ใน AL Programming

การใส่ความคิดเห็น (Comments) ในโค้ดเป็นส่วนสำคัญของการเขียนโปรแกรมที่ดี โดยช่วยให้โปรแกรมเมอร์สามารถอธิบายการทำงานของโค้ดหรือเตือนความจำเกี่ยวกับสิ่งที่ต้องทำในอนาคต ในภาษา AL (AL Language) ของ Dynamics 365 Business Central การใส่ความคิดเห็นสามารถทำได้สองแบบคือ การใส่ความคิดเห็นในบรรทัดเดียว (Single-line comments) และการใส่ความคิดเห็นในหลายบรรทัด (Multi-line comments)

1. Single-line Comments (ความคิดเห็นในบรรทัดเดียว)

Single-line comments ใช้สำหรับการใส่ความคิดเห็นในโค้ดที่สั้น ๆ และต้องการบรรยายเพียงบรรทัดเดียว โดยใช้สัญลักษณ์ // ตามด้วยข้อความที่ต้องการใส่ความคิดเห็น

ตัวอย่างการใช้งาน Single-line comments

    procedure CalculateTotalAmount()
   var
        Amount: Decimal;
        VATRate: Decimal;
        VATAmount: Decimal;
    begin
        // กำหนดค่าเริ่มต้นให้กับจำนวนเงินและอัตราภาษีมูลค่าเพิ่ม
        Amount := 1000;
        VATRate := 0.07; // อัตราภาษีมูลค่าเพิ่มคือ 7%

        // คำนวณภาษีมูลค่าเพิ่มจากจำนวนเงิน
        VATAmount := Amount * VATRate;

        // แสดงผลลัพธ์ของการคำนวณภาษีมูลค่าเพิ่ม
        Message('VAT Amount: %1', VATAmount);
    end;

ในตัวอย่างนี้, การใส่ความคิดเห็นแต่ละบรรทัดช่วยอธิบายว่าฟังก์ชันทำงานอย่างไรในแต่ละส่วน

2. Multi-line Comments (ความคิดเห็นในหลายบรรทัด)

Multi-line comments ใช้สำหรับการใส่ความคิดเห็นที่มีข้อความยาว ๆ หรืออธิบายหลายบรรทัด โดยใช้สัญลักษณ์ /* เพื่อเริ่มต้นความคิดเห็น และ */ เพื่อปิดความคิดเห็น

ตัวอย่างการใช้งาน Multi-line comments

    procedure CalculateDiscountedPrice()
    var
        Price: Decimal;
        DiscountRate: Decimal;
    begin
        /* 
        ฟังก์ชันนี้ใช้คำนวณราคาหลังจากหักส่วนลด
        โดยรับค่า Price และ DiscountRate ที่กำหนดไว้
        จากนั้นจะคืนค่าราคาที่ลดลงแล้ว
        */
        Price := 1000;
        DiscountRate := 0.1;

        // คำนวณราคาหลังหักส่วนลด
        Price := Price - (Price * DiscountRate);

        // แสดงราคาหลังหักส่วนลด
        Message('Discounted Price: %1', Price);
    end;

ในตัวอย่างนี้, การใส่ความคิดเห็นแบบหลายบรรทัดถูกใช้เพื่ออธิบายการทำงานของฟังก์ชันทั้งหมด

3. Best Practices (แนวทางปฏิบัติที่ดีในการใส่ความคิดเห็น)

• ใส่ความคิดเห็นที่จำเป็น: ไม่ควรใส่ความคิดเห็นในทุกบรรทัด แต่ควรใส่ในส่วนที่ต้องการคำอธิบายจริง ๆ
• ทำให้ความคิดเห็นเป็นปัจจุบัน: เมื่อมีการเปลี่ยนแปลงในโค้ด ควรอัปเดตความคิดเห็นให้ตรงกับการทำงานของโค้ด
• หลีกเลี่ยงความคิดเห็นที่ชัดเจนเกินไป: การใส่ความคิดเห็นที่อธิบายสิ่งที่โค้ดทำอย่างชัดเจนอยู่แล้ว เช่น // Add two numbers ควรหลีกเลี่ยง เพราะอาจไม่จำเป็น