📋 محتويات الصفحة
📖 الوصف
JSDoc هي أداة توليد توثيق من تعليقات JavaScript. تستخدم علامات خاصة في التعليقات (مثل @param, @returns, @example) لتوليد توثيق HTML تلقائياً من أكواد JavaScript و TypeScript. JSDoc هي المعيار الصناعي لتوثيق JavaScript، وتدعمها معظم المحررات.
🎯 يستخدم في
مجالات استخدام هذه الأداة
•
توثيق مكتبات JavaScript
•
API Documentation
•
مكتبات npm
•
التوثيق الداخلي
✨ المميزات
أبرز مميزات هذه الأداة
✓
المعيار الأقدم (منذ 2001)
✓
دعم جميع المحررات
✓
يحسن IntelliSense و IDE support
✓
templates قابلة للتخصيص
✓
plugins غنية
✓
يدعم JavaScript و TypeScript
⚠️ العيوب
نقاط يجب مراعاتها
×
توثيق HTML قديم نسبياً
×
يحتاج تثبيت plugins لـ themes
×
أقل حداثة من TypeDoc
💻 مثال على الاستخدام
كيفية استخدام هذه الأداة
# تثبيت JSDoc
npm install -g jsdoc
# توليد التوثيق
jsdoc src/index.js
# مع مجلد الإخراج
jsdoc -d docs src/
# مع ملف تكوين
jsdoc -c jsdoc.json📚 أدوات أخرى في Documentation
قد يعجبك أيضاً