coding · Cursor · free
أضف تعليقات TSDoc إلى هذا الكود. يجب أن توضح التعليقات «لماذا» و«ماذا»، ولا تكرر أبدًا «ماذا» يفعل الكود بشكل واضح. بالنسبة لكل رمز مُصدر، قم بإضافة: ملخص من جملة واحدة من شأنه أن يساعد المستخدم في ميزة الإكمال التلقائي @param فقط عندما لا يكون النوع واضحًا بذاته (الوحدات، النطاقات، القيم المسموح بها، "ليس فارغًا عندما يكون X") @returns فقط عندما لا يكون الشكل أو الشرط واضحًا @throws لكل مسار خطأ موثق @example لأي شيء له أكثر من شكل استدعاء معقول @deprecated مع البديل، إن أمكن @remarks للسلوك غير الواضح، والآثار الجانبية، وفئة التعقيد لا تقم بما يلي: إعادة ذكر اسم الدالة في الملخص إضافة @param count العدد — هذا زائد عن الحاجة، احذفه التعليق على أنواع المعلمات الواضحة عندما يخبرك TS بها بالفعل إضافة @author / @version — هذا من اختصاص git اجعل التعليقات أقل من 3 أسطر ما لم يكن «السبب» يحتاج فعلاً إلى المزيد. أعد الملف مع التعليقات مضمنة في النص.
#documentation #jsdoc #typescript