📋 محتويات الصفحة
📖 الوصف
TypeDoc هي أداة توليد توثيق من أكواد TypeScript. تقرأ التعليقات (JSDoc/TSDoc) ومعلومات الأنواع لإنشاء مواقع توثيق احترافية تلقائياً. تدعم TypeDoc إنشاء HTML، JSON، ومواقع متعددة الصفحات، مع دعم الـ themes والبحث.
🎯 يستخدم في
مجالات استخدام هذه الأداة
•
توثيق مكتبات TypeScript
•
توثيق API داخلي
•
Knowledge Base
•
مكتبات npm
✨ المميزات
أبرز مميزات هذه الأداة
✓
يقرأ TypeScript types
✓
يحول JSDoc و TSDoc
✓
يبحث تلقائياً
✓
themes مخصصة
✓
plugins غنية
✓
multi-module
⚠️ العيوب
نقاط يجب مراعاتها
×
TypeScript فقط
×
يعتمد على جودة التعليقات
×
قد يكون بطيئاً للمشاريع الكبيرة
💻 مثال على الاستخدام
كيفية استخدام هذه الأداة
# تثبيت TypeDoc
npm install -D typedoc
# توليد التوثيق
npx typedoc src/index.ts
# مع مجلد الإخراج
npx typedoc --out docs src/
# مع theme
npx typedoc --theme default src/📚 أدوات أخرى في Documentation
قد يعجبك أيضاً