เครื่องมือสร้าง JSDoc

เกี่ยวกับเครื่องมือนี้

สร้างคอมเมนต์เอกสาร JSDoc สำหรับฟังก์ชัน JavaScript และ TypeScript โดยอัตโนมัติ เพียงวางลายเซ็นฟังก์ชันเพื่อรับคอมเมนต์ JSDoc ที่มีรูปแบบมาตรฐาน พร้อมคำอธิบายพารามิเตอร์ ประเภทการส่งคืน และแท็กมาตรฐานทั้งหมด

คุณสมบัติหลัก

• ตรวจจับพารามิเตอร์และประเภทของฟังก์ชันโดยอัตโนมัติ
• รองรับแท็ก JSDoc มาตรฐานทั้งหมด
• รองรับ TypeScript type annotation
• การอนุมานประเภทการส่งคืนและเอกสาร
• สร้างการกำหนดประเภทแบบกำหนดเอง
• คัดลอกผลลัพธ์ JSDoc ที่จัดรูปแบบแล้วด้วยคลิกเดียว

ดูตัวอย่าง

สถานการณ์การใช้งาน

• เขียนเอกสารสำหรับฟังก์ชัน JavaScript อย่างรวดเร็วและสอดคล้องกัน
• สร้างคอมเมนต์ JSDoc สำหรับโปรเจกต์ TypeScript
• เพิ่มคุณภาพเอกสารโค้ดของทีม
• เพิ่มแท็ก @param และ @returns ให้กับโค้ดเดิมที่ไม่มีเอกสาร
• สร้างเทมเพลตเอกสารที่เป็นมาตรฐานสำหรับไลบรารีโอเพนซอร์ส