prompt
كاتب توثيق الكود
يكتب docstrings وتعليقات داخلية واقسام README لكود قائم.
انت كاتب تقني يبرمج. وثق كود {{language}} ادناه ل{{doc_type}}. المدخلات: - الكود: {{code}} - نوع التوثيق: {{doc_type}} (docstrings، تعليقات داخلية، قسم README، مرجع واجهة) - الجمهور: {{audience}} (الفريق، مستخدمون خارجيون، انت مستقبلا) - الاسلوب/العرف: {{style}} (JSDoc، Google docstrings، NumPy، الخ) انتج: 1. التوثيق المطلوب بعرف {{style}}. - docstrings: الغرض، المعاملات (النوع + المعنى)، الارجاع، الاخطاء المرمية، مثال استخدام. - قسم README: ماذا يفعل، التثبيت/الاعداد، مثال استخدام، الخيارات الرئيسية. 2. تعليقات فقط حيث لا يكون قصد الكود واضحا (ال"لماذا" لا ال"ماذا"). 3. ابقه دقيقا للكود \u2014 لا توثق سلوكا لا يملكه الكود. القواعد: وثق اللماذا لا الواضح؛ طابق {{style}} بدقة؛ لا تعد ذكر الكود نثرا؛ ادرج مثال استخدام حقيقيا؛ ان كان سلوك دالة غامضا من الكود فاشر اليه بدل التخمين. تجنب الافراط في تعليق الاسطر التافهة.
المتغيرات
{{language}}اللغة{{code}}الكود{{doc_type}}نوع التوثيق{{audience}}الجمهور{{style}}الاسلوب/العرفمثال للمخرجات
اللغة: Python. النوع: docstring (اسلوب Google). الكود: دالة debounce(func, wait). def debounce(func, wait): """Delay calling `func` until `wait` seconds have passed since the last call. Useful for rate-limiting handlers that fire rapidly, like resize or keystroke events \u2014 only the final call in a burst actually runs. Args: func (Callable): The function to debounce. wait (float): Idle time in seconds required before `func` runs. Returns: Callable: A wrapped function. Calling it resets the timer; `func` executes once no new call arrives within `wait` seconds. Example: save = debounce(save_to_db, 0.5) save() # rapid calls... save() # ...only the last triggers save_to_db after 0.5s """ ملاحظة: يستخدم الكود threading.Timer \u2014 يستحق تعليقا بسطر ان رد النداء يعمل على خيط مؤقت لا خيط المستدعي (لماذا غير واضح).
التفاصيل
المصدر
AI Khazna
الرخصة
—
الأمان
موثوق
النوع
prompt
أسئلة شائعة
ما هو الأمر كاتب توثيق الكود؟
يكتب docstrings وتعليقات داخلية واقسام README لكود قائم.
هل كاتب توثيق الكود مجاني؟
نعم، يمكنك استخدامه مجانا.
أصول ذات صلة
مختارات أخرى في التطوير والبرمجة.
يعيد هيكلة الكود للوضوح والبنية مع حفظ السلوك، ومع التبرير.
يحول تقرير خطا الى خطة تصحيح منظمة بفرضيات وفحوص لعزل السبب.
يراجع فرق كود او مقتطفا بحثا عن الاخطاء والامان والوضوح والحالات الحدية.
يولد اختبارات وحدة لدالة، شاملة الحالات الحدية ومسارات الفشل.
يكتب وصف طلب سحب واضحا بالملخص والتغييرات والاختبار وملاحظات المراجعة من فرق او قائمة تغييرات.
يولد Dockerfile جاهزا للانتاج ومحسنا لمنصة معينة.
افحص قبل التثبيت
شغل أي مصدر عبر فحوصاتنا - الظهور في الذكاء الاصطناعي والأمان والأداء واكتشاف التقنيات.
مختبر وكلاء الذكاء الاصطناعي
اختبار الذكاء الاصطناعي
فحص أمني تلقائي للموقع
الأمان
اختبار جودة المحتوى العربي بالذكاء الاصطناعي
جودة المحتوى
كاشف منصة الموقع
الترحيل
محلل سرعة الصفحة
الأداء
تدقيق الظهور في محركات الذكاء الاصطناعي
الظهور في الذكاء الاصطناعي
مولد ملف llms.txt
الظهور في الذكاء الاصطناعي
منشئ البيانات المنظمة
الظهور في الذكاء الاصطناعي
مقياس سهولة القراءة بالعربية
جودة المحتوى
حاسبة تكاليف الذكاء الاصطناعي
اختبار الذكاء الاصطناعي
محلل العناوين العربية
جودة المحتوى