Debugging (การตรวจจับบั๊กใน Revit)

เนื่องจากโปรเจ็กต์ Revit Plugin เป็นประเภท Class Library (DLL) ซึ่งเราไม่สามารถกดเบิ้ลคลิกหรือสั่งรันตรงๆ ได้เหมือนแอปพลิเคชันทั่วไป เราจึงต้องตั้งค่าให้ Visual Studio ทำหน้าที่เป็นสะพานเปิดโปรแกรม Revit.exe ขึ้นมา แล้วทำการเชื่อมโยงสายสัญญาณ (Attach Debugger) เข้าไปเพื่อตรวจจับบั๊กในโค้ดครับ

---

🛠️ ขั้นตอนการตั้งค่า Launch Profile (ทีละขั้นตอน)

ให้เปิดโปรแกรม Visual Studio ของคุณขึ้นมา แล้วทำตามขั้นตอนต่อไปนี้ได้เลยครับ:

ขั้นตอนที่ 1: เข้าสู่หน้าต่างโปรเจ็กต์ Properties

1. ที่แถบ Solution Explorer (ขวามือของจอ) ให้ทำการคลิกขวาที่ชื่อโปรเจ็กต์ของคุณ (เช่น RevitToolkit)
2. เลือกเมนูล่างสุดที่ชื่อว่า Properties (หรือคลิกที่ชื่อโปรเจ็กต์แล้วกดปุ่มลัด Alt + Enter บนคีย์บอร์ด)
3. เมื่อหน้าต่างตั้งค่าเปิดขึ้นมา ให้มองหาแท็บเมนูด้านซ้ายและคลิกเลือกไปที่หมวดหมู่ Debug
4. ในหน้าต่างหลัก คุณจะเห็นลิงก์ตัวหนังสือสีน้ำเงินเขียนว่า Open debug launch profiles UI ให้กดคลิกเข้าไปได้เลยครับ

---

ขั้นตอนที่ 2: สร้างและคอนฟิกโปรไฟล์ดีบั๊ก

เมื่อหน้าต่างป๊อปอัป Launch Profiles เด้งขึ้นมา ให้ดำเนินการดังนี้:

1. เพิ่มโปรไฟล์ใหม่ (Add Profile):

   • มองไปที่ขอบบนซ้ายสุดของหน้าต่างย่อยนี้ จะมีไอคอนเครื่องหมายบวกสีเขียวเล็กๆ บนรูปกระดาษ (Add launch profile)
   • ให้ทำการคลิกแล้วเลือกหัวข้อ Executable
   • ระบบจะสร้างแถบใหม่ขึ้นมาทางซ้ายชื่อว่า Profile 1

2. กรอกค่าโปรแกรมที่จะใช้รัน (Executable Path):

   • ที่ช่อง Executable ทางฝั่งขวา ให้ใส่พาธรันโปรแกรม Revit ในเครื่องของคุณลงไป:

     C:\Program Files\Autodesk\Revit 2026\Revit.exe

     (หากคุณใช้เวอร์ชันอื่น เช่น 2027 อย่าลืมแก้ไขตัวเลขปีให้ตรงกับเวอร์ชันที่คุณติดตั้งจริง)

3. กรอกค่าโฟลเดอร์รันระบบ (Working Directory):

   • ที่ช่อง Working directory (เลื่อนลงไปล่างสุดทางขวา) ให้ใส่โฟลเดอร์ทำงานหลักของ Revit ลงไป:

     C:\Program Files\Autodesk\Revit 2026\

4. ตั้งชื่อโปรไฟล์เพื่อความเป็นระเบียบ (Rename):

   • ที่ตัวหนังสือ Profile 1 ในรายการแถบด้านซ้าย ให้ทำการดับเบิลคลิก (หรือคลิกขวาเลือก Rename / กดปุ่ม F2) แล้วเปลี่ยนชื่อเป็น Revit 2026 Debug

5. บันทึกและปิดหน้าต่าง:

   • กดคีย์ลัด Ctrl + S เพื่อบันทึกค่าคอนฟิกทั้งหมด จากนั้นกดปุ่มกากบาท (X) ปิดหน้าต่างย่อยนี้ลงได้เลยครับ!

---

🚀 วิธีเปิดดีบั๊กใช้งานจริง

เมื่อตั้งค่าโปรไฟล์เสร็จแล้ว ทุกครั้งที่คุณต้องการเขียนโค้ดและทดสอบ ให้ทำตามนี้ครับ:

1. วาง Breakpoint (จุดหยุดตรวจ):

   • เปิดไฟล์คำสั่งของคุณ เช่น Command.cs
   • เอาเมาส์ไปคลิกที่แถบสีเทา ซ้ายมือสุด ของแถวบรรทัดคำสั่งที่ต้องการหยุดตรวจ (เช่น ในฟังก์ชัน Execute(...) ตรงบรรทัด TaskDialog.Show(...)) จะปรากฏ วงกลมสีแดงเข้ม ขึ้นมา

2. เลือกโปรไฟล์การดีบั๊ก:

   • ที่แถบเครื่องมือด้านบนสุดของ Visual Studio สังเกตข้างๆ ปุ่มลูกศรสีเขียว ▷
   • คลิกที่ Dropdown ตัวเลือกการรันแล้วเปลี่ยนให้เป็นโปรไฟล์ Revit 2026 ที่เราเพิ่งสร้างขึ้นมา

3. กด F5 สตาร์ทโปรแกรม:

   • กดปุ่ม F5 บนคีย์บอร์ด หรือคลิกที่ปุ่มลูกศรสีเขียว Revit 2026
   • ตัว Visual Studio จะทำการเปิดโปรแกรม Revit ขึ้นมาให้เองโดยอัตโนมัติพร้อมระบบ Attach Debugger!

4. ตรวจสอบผลลัพธ์:

   • เปิดโมเดล Revit ขึ้นมาแล้วลองกดปุ่มปลั๊กอินของคุณ
   • ตัวหน้าจอ Revit จะค้างชั่วคราว และหน้าจอจะดีดกลับมาที่ Visual Studio โดยแถบสีเหลืองจะไปจ่อหยุดอยู่ตรงจุดวงกลมสีแดงที่มาร์กไว้
   • ตอนนี้คุณสามารถนำเมาส์ไปชี้ที่ตัวแปรต่างๆ เพื่อเช็กค่าที่เกิดขึ้นจริงขณะรันได้ทันทีเลยครับ!

---

💡 ทางเลือกเสริม: การดีบั๊กผ่าน Visual Studio Code (Optional)

หากคุณชอบความเบาและรวดเร็วของ Visual Studio Code (VS Code) คุณก็สามารถทำการดีบั๊กปลั๊กอิน Revit ได้เช่นเดียวกันครับ โดยใช้ขั้นตอนการตั้งค่าดังนี้:

1. ติดตั้ง Extension ที่จำเป็น

เปิด VS Code แล้วทำการติดตั้งส่วนขยายตัวสำคัญจาก Microsoft:

• C# Dev Kit (ซึ่งรวมระบบการดีบั๊ก C# บน CoreCLR มาให้เรียบร้อยแล้ว)

2. สร้างไฟล์คอนฟิก .vscode/launch.json

ในระดับชั้นนอกสุดของโฟลเดอร์โปรเจ็กต์ ให้สร้างโฟลเดอร์ชื่อ .vscode ขึ้นมา และสร้างไฟล์ชื่อ launch.json ไว้ด้านใน จากนั้นนำโค้ดการตั้งค่านี้ไปวาง:

.vscode/launch.json

{
  "version": "0.2.0",
  "configurations": [
    {
      "name": "Revit 2026 Debug",
      "type": "coreclr",
      "request": "launch",
      "program": "C:\\Program Files\\Autodesk\\Revit 2026\\Revit.exe",
      "args": [],
      "cwd": "${workspaceFolder}",
      "stopAtEntry": false,
      "console": "internalConsole"
    }
  ]
}

(หากคุณใช้ Revit เวอร์ชันอื่น อย่าลืมแก้ไขพาธในช่อง program ให้ชี้ไปยังปีเวอร์ชันที่คุณติดตั้งในเครื่องนะครับ)

⚠️ ข้อควรระวังระดับห้าดาว (หลีกเลี่ยงข้อผิดพลาด Unknown Launch Target)

โฟลเดอร์ .vscode และไฟล์ launch.json จะต้องวางไว้ที่ “โฟลเดอร์นอกสุด (Root Folder) ที่คุณเปิดใช้งานในหน้าต่าง VS Code เท่านั้น”

หากคุณเผลอไปสร้างโฟลเดอร์นี้ซ้อนไว้ภายในโฟลเดอร์ย่อยด้านใน (เช่น ชื่อโปรเจ็กต์/ชื่อโปรเจ็กต์/.vscode) ตัวโปรแกรม VS Code จะมองไม่เห็นโปรไฟล์รันดีบั๊กที่เราตั้งค่าไว้ และเมื่อกด F5 รันดีบั๊ก ระบบจะแจ้งเตือนความผิดพลาดสีแดงมุมขวาล่างว่า Unknown Launch Target type (เนื่องจาก VS Code ไปพยายามรันดีบั๊กไฟล์ .dll ของปลั๊กอินตรงๆ แทนการสั่งดึงเปิด Revit.exe ครับ)

3. วิธีการดีบั๊กใน VS Code

1. เปิดไฟล์ซอร์สโค้ด C# เช่น Command.cs แล้วทำการวาง Breakpoint (จุดแดง) ตรงบรรทัดที่ต้องการโดยคลิกที่ขอบขวาของตัวเลขบรรทัด
2. คลิกไปที่ปุ่ม Run & Debug (ไอคอนรูปแมลงติดเพลย์สามเหลี่ยมสีซ้ายมือ หรือกดปุ่มลัด Ctrl + Shift + D)
3. สังเกตที่ดรอปดาวน์เลือกโปรไฟล์การดีบั๊กด้านบนสุด ให้เลือกเป็นโปรไฟล์ Revit 2026 Debug
4. กดปุ่ม F5 (หรือกดปุ่มลูกศรสีเขียวเล็กๆ ข้างชื่อโปรไฟล์)
5. ตัว VS Code จะเปิดโปรแกรม Revit ขึ้นมาพร้อมดีบั๊ก เมื่อปุ่มโดนกดใน Revit โค้ดจะหยุดนิ่งตรงจุด Breakpoint ให้คุณเช็กข้อมูลได้ทันทีครับ!