JSDoc
Wed 15 Jan 2025
🎉 Hi: ... 🎉
JSDoc Source เป็นเครื่องมือสร้างเอกสาร API สำหรับ JavaScript โดยจะดึงข้อมูลจากคอมเมนต์ในโค้ดของเรา เพื่อสร้างเป็นเอกสารที่อ่านง่าย ทำให้คนอื่น เข้าใจโค้ดของเราได้ง่ายขึ้น
VS Code จะสามารถแนะนำ parameter และ type ต่างๆ ได้จาก JSDoc ที่เราเขียนไว้
ทำให้สามารถเรียกใช้งานได้อย่างถูกต้องและลดปัญหาข้อผิดพลาดจากการเขียนโปรแกรมตัวอย่างการใช้ JSDoc เพื่อกำหนด Type ของตัวแปร
บรรทัดที่ 1 ให้กำหนดค่า
// @ts-check
ไว้ที่บันทัดแรกของไฟล์บรรทัดที่ 4 เขียน comment และกำหนดตัวแปร
someData
เป็น{string}
บรรทัดที่ 11 เรียกใช้ testA() และส่งค่าตัวแปร
123
เป็น{number}
จะเป็นการใช้งานที่ไม่ถูกต้อง
js// @ts-check /** * @param {string} someData */ const testA = (someData) => { console.log('🚀 ~ ', someData) } // test testA(123)
Output