การเขียน Comment ในภาษา C# (C# Comments)

การเขียน Comment ในภาษา C#
ในภาษา C# (C-Sharp) “Comment” หรือ “หมายเหตุในโค้ด” คือข้อความที่ถูกเขียนไว้ในโปรแกรมเพื่อช่วยอธิบายการทำงานของโค้ด แต่ จะไม่ถูกคอมไพล์หรือประมวลผลโดยคอมพิวเตอร์

คอมเมนต์มีประโยชน์มากสำหรับการทำงานร่วมกัน การอ่านโค้ดย้อนหลัง หรือการเขียนเอกสารประกอบโปรแกรม

ทำไมการเขียน Comment จึงสำคัญ

1. ช่วยอธิบายโค้ดให้คนอื่นเข้าใจง่ายขึ้น
   โดยเฉพาะในโปรเจ็กต์ขนาดใหญ่ที่มีหลายคนร่วมกันพัฒนา
2. ช่วยเตือนความจำตัวเองในอนาคต
   เวลาย้อนกลับมาดูโค้ดที่เขียนไว้ จะเข้าใจเจตนาได้ทันที
3. ช่วยในการดีบักและทดสอบโค้ด
   สามารถคอมเมนต์บางส่วนของโค้ดเพื่อหยุดการทำงานชั่วคราวโดยไม่ต้องลบออก
4. ช่วยสร้างเอกสารอัตโนมัติ (XML Documentation)
   ใน Visual Studio สามารถใช้คอมเมนต์แบบ XML เพื่อสร้างเอกสาร API ได้โดยอัตโนมัติ

ประเภทของ Comment ในภาษา C#

ภาษา C# มีคอมเมนต์อยู่ทั้งหมด 3 รูปแบบหลัก ได้แก่

1. Single-line comment — คอมเมนต์แบบบรรทัดเดียว
2. Multi-line comment — คอมเมนต์แบบหลายบรรทัด
3. XML Documentation comment — คอมเมนต์แบบเอกสารประกอบโค้ด

Single-line Comment (คอมเมนต์แบบบรรทัดเดียว)

คอมเมนต์แบบบรรทัดเดียวใช้เครื่องหมาย // นำหน้าข้อความ เหมาะสำหรับอธิบายโค้ดเฉพาะบรรทัด หรือใส่หมายเหตุสั้น ๆ

namespace MyConsoleApp
{
    internal class Program
    {
        static void Main(string[] args)
        {
            // แสดงข้อความทักทาย
            Console.WriteLine("สวัสดี C#");
        }
    }
}

namespace MyConsoleApp
{
    internal class Program
    {
        static void Main(string[] args)
        {
            // แสดงข้อความทักทาย
            Console.WriteLine("สวัสดี C#");
        }
    }
}

• // บอกให้คอมไพเลอร์ข้ามข้อความที่อยู่หลังเครื่องหมายนี้ทั้งบรรทัด
• ข้อความ “แสดงข้อความทักทาย” มีไว้เพื่ออธิบายว่าโค้ดบรรทัดถัดไปทำอะไร
• โปรแกรมจะรันเฉพาะ Console.WriteLine("สวัสดี C#"); เท่านั้น

Multi-line Comment (คอมเมนต์แบบหลายบรรทัด)

ใช้เมื่อต้องการเขียนคำอธิบายหลายบรรทัด หรือคอมเมนต์โค้ดจำนวนมากในคราวเดียว
เริ่มต้นด้วย /* และสิ้นสุดด้วย */

namespace MyConsoleApp
{
    internal class Program
    {
        static void Main(string[] args)
        {
            /* 
               โปรแกรมนี้ใช้แสดงผลข้อความภาษาไทย
               ตัวอย่างนี้แสดงการใช้ Multi-line Comment
            */
            Console.WriteLine("ยินดีต้อนรับสู่ภาษา C#");
        }
    }
}

namespace MyConsoleApp
{
    internal class Program
    {
        static void Main(string[] args)
        {
            /* 
               โปรแกรมนี้ใช้แสดงผลข้อความภาษาไทย
               ตัวอย่างนี้แสดงการใช้ Multi-line Comment
            */
            Console.WriteLine("ยินดีต้อนรับสู่ภาษา C#");
        }
    }
}

• เครื่องหมาย /* เปิดคอมเมนต์ และ */ ปิดคอมเมนต์
• ข้อความระหว่างเครื่องหมายทั้งสองจะไม่ถูกประมวลผล
• ใช้ได้ทั้งการอธิบายโค้ดหลายบรรทัด หรือคอมเมนต์โค้ดทดสอบชั่วคราว

ตัวอย่างการคอมเมนต์โค้ดชั่วคราว

Console.WriteLine("Hello");
/*
Console.WriteLine("World");
*/

Console.WriteLine("Hello");
/*
Console.WriteLine("World");
*/

• โค้ดที่อยู่ภายใน /* ... */ จะถูกข้าม
• โปรแกรมจะแสดงเฉพาะข้อความ “Hello” เท่านั้น
• เทคนิคนี้มักใช้ในช่วงดีบักเพื่อปิดการทำงานบางส่วนโดยไม่ต้องลบออก

XML Documentation Comment

เป็นคอมเมนต์พิเศษที่ใช้เครื่องหมาย /// (สามขีด) ออกแบบมาเพื่อสร้างเอกสารประกอบโค้ดอัตโนมัติ เช่น สำหรับ API หรือคลาสในโปรเจ็กต์ขนาดใหญ่

/// <summary>
/// คลาสนี้ใช้สำหรับจัดการข้อมูลนักเรียน
/// </summary>
public class Student
{
    /// <summary>
    /// เก็บชื่อของนักเรียน
    /// </summary>
    public string Name { get; set; }

    /// <summary>
    /// แสดงชื่อของนักเรียน
    /// </summary>
    public void ShowName()
    {
        Console.WriteLine($"ชื่อ: {Name}");
    }
}

/// <summary>
/// คลาสนี้ใช้สำหรับจัดการข้อมูลนักเรียน
/// </summary>
public class Student
{
    /// <summary>
    /// เก็บชื่อของนักเรียน
    /// </summary>
    public string Name { get; set; }

    /// <summary>
    /// แสดงชื่อของนักเรียน
    /// </summary>
    public void ShowName()
    {
        Console.WriteLine($"ชื่อ: {Name}");
    }
}

• /// คือการเริ่มต้นคอมเมนต์แบบ XML
• <summary> ใช้ระบุคำอธิบายของคลาสหรือเมธอด
• สามารถเพิ่มแท็กอื่น ๆ เช่น <param> (พารามิเตอร์), <returns> (ค่าที่ส่งกลับ)
• Visual Studio จะใช้คอมเมนต์เหล่านี้สร้างเอกสารอัตโนมัติเมื่อเรานำเมาส์ชี้บนชื่อคลาสหรือเมธอด

ตัวอย่างการใช้งานแท็ก XML อื่น ๆ

/// <summary>
/// คำนวณผลรวมของตัวเลขสองจำนวน
/// </summary>
/// <param name="a">จำนวนที่ 1</param>
/// <param name="b">จำนวนที่ 2</param>
/// <returns>ผลบวกของ a และ b</returns>
static int Add(int a, int b)
{
    return a + b;
}

/// <summary>
/// คำนวณผลรวมของตัวเลขสองจำนวน
/// </summary>
/// <param name="a">จำนวนที่ 1</param>
/// <param name="b">จำนวนที่ 2</param>
/// <returns>ผลบวกของ a และ b</returns>
static int Add(int a, int b)
{
    return a + b;
}

• <param> อธิบายความหมายของแต่ละพารามิเตอร์ในเมธอด
• <returns> ระบุค่าที่เมธอดจะส่งกลับ
• Visual Studio แสดงข้อมูลเหล่านี้ใน Tooltip ช่วยให้ผู้ใช้เมธอดเข้าใจทันที

ข้อควรปฏิบัติในการเขียน Comment ที่ดี

1. เขียนคอมเมนต์ให้สั้น กระชับ และชัดเจน
2. อธิบาย “เหตุผล” ที่โค้ดต้องทำ ไม่ใช่แค่ “โค้ดทำอะไร”
3. ใช้ภาษาเดียวกันทั้งโปรเจ็กต์ (เช่น ภาษาไทยหรืออังกฤษ)
4. อัปเดตคอมเมนต์ให้ตรงกับโค้ดเสมอ ไม่ให้ข้อมูลล้าสมัย
5. หลีกเลี่ยงคอมเมนต์ที่ไม่จำเป็น