1 مستودع
Tags used to control the visibility of documentation content in generated outputs.
Distinct from Documentation Comment Generators: Distinct from Documentation Comment Generators: focuses on the specific metadata for hiding content rather than the generation process.
Explore 1 awesome GitHub repository matching programming languages & runtimes · Visibility Modifiers. Refine with filters or upvote what's useful.
TSDoc هو معيار توثيق ومواصفات لكتابة التعليقات المهيكلة في كود TypeScript. يوفر نظاماً قابلاً للنقل لتعريف البيانات الوصفية، والوسوم، والمراجع التبادلية داخل الكود المصدري لضمان التحليل والعرض المتسق عبر الأدوات المختلفة. يتضمن المشروع محلل تعليقات توثيق يقوم بتحويل التعليقات إلى شجرة بناء جملة مهيكلة، ومدققاً يفرض اتساق بناء الجملة. يسمح بتعريف وسوم توثيق مخصصة من خلال ملفات تكوين خارجية ويدعم أوضاع التحقق من بناء الجملة المتعددة للمساعدة في الامتثال للمواصفات. تغطي المواصفات مجموعة واسعة من احتياجات توثيق API، بما في ذلك تحديد مراحل الإصدار، والاستقرار، والإهمال. تدعم تفصيل معاملات الدوال، وقيم الإرجاع، وأنواع الاستثناءات، بالإضافة إلى إدارة الرؤية الداخلية، والوراثة، والمراجع التبادلية بين الإعلانات.
Provides mechanisms to mark documentation sections as private to exclude them from public API references.