Online JSDoc Generator

الغرض ونية المستخدم: الأداة تولّد توثيق JSDoc من مصادر JavaScript وTypeScript. تقرأ ملفات المصدر، وتستخرج التصريحات الموثقة، وتنتج مرجع API منظّم مناسب لمؤلفي المكتبات وفرق SDK ومشروعات المصدر المفتوح. تدعم أنواع TS عند وجودها، وتُحسّن دقة أوصاف المعلمات وتتيح ربطًا دقيقًا بين الوحدات والرموز.
المنطق الأساسي والميزات: تقبل الأداة المصادر، وتستخرج كتل JSDoc، وتربط الرموز، وتصدر إلى HTML أو Markdown أو JSON. تدعم مشاريع متعددة الملفات ومجلدات ومدخلات المستودع. تشمل الخيارات المتقدمة قوالب مخصصة، تجميع الوحدات، رؤية الأعضاء الخاصة، إنشاء تدريجي، استنتاج أنواع TypeScript، وتوصيلات ما بعد المعالجة لـ CI.
المدخلات والمخرجات: المدخلات تشمل source_paths (سلسلة أو مصفوفة)، اللغة (JS/TS)، format_output (html/markdown/json)، قالب (اسم أو محتوى)، include_private (Boolean). المخرجات تشمل docs_html، docs_markdown، docs_json وفهرس للوحدات/الأصناف وفهرس قابل للبحث.
الخوارزميات والحسابات: تستخدم تحليل AST لجمع الرموز وتعليقات JSDoc، وتوثيق التعليقات بالتصريحات، وتحديد حدود الوحدة، وتطبيق القوالب لإنتاج توثيق منظم. تحقق من صحة البنية وتتعامل مع البنى غير المدعومة مع وجود عناصر نائبة للتعليقات المفقودة.
الأخطاء والحالات الحدية: تتعامل مع JSDoc المفقودة أو الناقصة مع سجلات التحذير وتوليد توثيق جزئي؛ تتعامل مع قواعد بيانات كبيرة عبر المعالجة التدفقية؛ تعطي قيم افتراضية للخيارات غير المحددة؛ تنبه عند فشل الوصول إلى المستودع أو وجود قيود سرعة.
الصناعة/المنطقة والتوطين: تتبع تقاليد تعليقات الشفرة الإنجليزية الأمريكية؛ القوالب تدعم عناوين محلية؛ لا توجد بيانات عملة أو إقليمية؛ تتوافق مع تقاليد توثيق JavaScript/TypeScript.
الافتراضات والاستثناءات: تفترض أن المدخلات هي شفرة قابلة للوصول والتحليل؛ تستثني توثيق تشغيل الشفرة في الوقت الحقيقي والبيانات وقت التشغيل أو توليد واجهة مستخدم؛ غير مسؤول عن الاستضافة أو العرض خارج الصيغ المخرجة المختارة.