docc2json
أداة CLI سريعة لتحويل وثائق DocC الخاصة بـ Xcode إلى صيغة JSON منظمة وقابلة للنشر.
أداة Go سريعة تحول وثائق DocC الخاصة بـ Xcode إلى ملف JSON مُحسّن لمواقع الويب و SDKs، مع دعم التجميع والمرشحات.
المزيد عن docc2json
docc2json
أداة سطر أوامر Go سريعة تعمل على تحليل مخرجات وثائق DocC من Apple وتحويلها إلى ملف JSON منظم ونظيف ومُحسّن لمواقع وثائق الويب وSDKs. يتيح لك هذا المنتج تحويل وثائق Xcode DocC إلى JSON.
- •تحليل مخرجات DocC:يعمل على تحليل مخرجات DocC JSON من مجلدات .doccarchive أو المستندات المعالجة، مما يضمن توافقًا كاملاً.
- •توليد مخطط SDK مخصص:يقوم بإنشاء مخطط JSON مُخصص مع معلومات نوع كاملة وتوقيعات أساليب وتوثيق، مما يتيح تكاملاً شاملاً.
- •استخراج وثائق شامل:يستخرج الملخصات والمناقشات والأمثلة وقوائم التعليمات البرمجية من تعليقات DocC، مما يضمن توثيقًا كاملاً.
- •تصفية حسب مستوى الوصول:يتيح تصفية الرموز بناءً على مستوى الوصول مع علامة اختيارية `--public-only`، مما يوفر تحكمًا دقيقًا.
- •معالجة متوازية سريعة:يستخدم المعالجة المتوازية لملفات JSON، مما يسرع عملية التحويل بشكل كبير.
- •استخراج بيانات تعريف غنية:يتضمن معلمات وأنواع إرجاع ومعدلات async/throws، مما يضمن معلومات تفصيلية.
- •حل المراجع المتبادلة:يعمل على حل المراجع المتبادلة لعلاقات الأنواع والامتثال للبروتوكول، مما يحافظ على الاتساق.
- •إزالة تشويه البروتوكول تلقائيًا:يحول أسماء بروتوكولات Swift المشوهة (مثل `s8SendableP`) إلى أسماء نظيفة (مثل `Sendable`)، مما يحسن إمكانية القراءة.
- •تصفية الامتثال الذكية:يقوم بتصفية بروتوكولات مكتبة Swift القياسية مع الاحتفاظ بالبروتوكولات المخصصة، مما يضمن الدقة.
- •خيارات تجميع مرنة:تجميع الأنواع حسب البادئة أو التكوين المخصص، مما يوفر تنظيمًا أفضل.
- •دعم المقالات والبرامج التعليمية:يتضمن اختياريًا مقالات وثائقية وبرامج تعليمية، مما يعزز التوثيق.
- •إنشاء هيكل الملاحة:ينشئ هيكل تنقل سهل لدمجه في موقع الويب، مما يسهل الاستخدام.
في عالم اليوم، يعد توثيق SDK أمرًا بالغ الأهمية لتجربة المطورين. من خلال اختيار docc2json، يمكنك تحويل وثائق DocC الخاصة بك إلى تنسيق JSON منظم وقابل للاستخدام بسهولة. يوفر هذا الأداة وقتك ويحسن سير عملك، مما يضمن وثائق دقيقة وشاملة. ثق بهذه الأداة لتعزيز عملية توثيق SDK الخاصة بك.
