اختصار يعمل بالتوجيه
الأمر نفسه يظهر للمشتركين

توثيق الدوال داخل الكود

يضيف تعليقات توثيق قياسية للدوال والأصناف حسب لغة المشروع.

توضيح مهم: معظم الاختصارات دي مش أوامر رسمية مبرمجة داخل ChatGPT. هي كلمات بتوجّه الذكاء الاصطناعي لتنفيذ مهمة معينة. بعضها منتشر، وبعضها اختصارات عملية تقدر تستخدمها بنفسك. النتائج ممكن تختلف حسب النموذج، والأفضل تضيف تفاصيل بعد الأمر.

تستخدمه إزاي؟

اكتب الأمر في أول رسالتك للأداة، وبعده طلبك بالتفصيل. الأمر نفسه وطرق كتابته متاحة للمشتركين.

الشرح

«الأمر» يطلب كتابة تعليقات توثيق بصيغة اللغة المعتمدة (docstring في Python، JSDoc في JavaScript، Javadoc في Java، تعليقات Go) لوصف الدالة ومعاملاتها وقيمة الإرجاع والاستثناءات المحتملة مع مثال استخدام قصير. هدفه جعل الكود مفهومًا لمن يقرؤه بعدك ولأدوات توليد التوثيق. حدوده: النموذج يستنتج الغرض من الكود، فقد يصف سلوكًا لا يطابق نيتك الحقيقية إن كان الكود غامضًا؛ راجع الوصف، وتجنب الحشو الذي يكرر اسم الدالة دون إضافة معلومة.

طرق الاستخدام والمثال الجاهز للمشتركين

  • كل طرق كتابة الأمر ومعنى كل طريقة
  • مثال جاهز تنسخه بضغطة وتجرّبه على طول
  • نصائح لنتيجة أدق وأوامر مرتبطة

مشترك بالفعل؟ سجّل الدخول