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

أصول ذات صلة

مختارات أخرى في التطوير والبرمجة.

mcp serverclaude_codecursorcodex
npm install @modelcontextprotocol/server-everything
خادم الاختبار الشامل (Everything)
خادم مرجعي للاختبار يجرب كل ميزات بروتوكول MCP — الأوامر والموارد والأدوات.★ ٤.٩ · ٥,٠٠٠+
mcp serverclaude_codecursorcodex
npm install @modelcontextprotocol/server-memory
خادم الذاكرة (Memory)
نظام ذاكرة دائمة قائم على رسم بياني معرفي. يتيح للوكلاء تذكر المعلومات عبر المحادثات.★ ٤.٩ · ٥,٠٠٠+
mcp serverclaude_codecursorcodex
npm install @modelcontextprotocol/server-filesystem
خادم نظام الملفات (Filesystem)
عمليات ملفات آمنة مع ضوابط وصول قابلة للضبط. قراءة الملفات المحلية وكتابتها وسردها والبحث فيها.★ ٤.٩ · ٥,٠٠٠+
mcp serverclaude_codecursorcodex
npm install @modelcontextprotocol/server-git
خادم Git
أدوات لقراءة مستودعات Git والبحث فيها والتحكم بها — السجل والفروقات وتتبع المؤلفين والفروع والمزيد.★ ٤.٩ · ٥,٠٠٠+
mcp serverclaude_codecursorcodex
npm install @modelcontextprotocol/server-fetch
خادم جلب الويب (Fetch)
خادم لجلب محتوى الويب وتحويله لاستخدام فعال مع نماذج اللغة. يجلب الروابط ويحولها إلى ماركداون نظيف.★ ٤.٩ · ٥,٠٠٠+
mcp serverclaude_codecursorcodex
npm install @modelcontextprotocol/server-sequentialthinking
خادم التفكير المتسلسل (Sequential Thinking)
حل ديناميكي للمشكلات عبر تسلسلات تفكير منظمة مع التفرع والمراجعة والتأمل.★ ٤.٩ · ٥,٠٠٠+

افحص قبل التثبيت

شغل أي مصدر عبر فحوصاتنا - الظهور في الذكاء الاصطناعي والأمان والأداء واكتشاف التقنيات.

المزيد في التطوير والبرمجة