راجع ميزات "الشرح" و"التوثيق" في GitHub Copilot
GitHub Copilot يسهل على المطورين العمل مع كود معقد أو غير مألوف. في تعليمة Visual Studio برمجية، لدى المطورين وصول مباشر إلى ميزات GitHub Copilot التي تحلل أو تشرح أو توثق الكود.
تحليل وشرح الكود باستخدام GitHub Copilot
يمكن استخدام الميزات GitHub Copilot التالية لتحليل وشرح الكود:
وضع السؤال: استخدم طريقة عرض الدردشة في وضع السؤال لتحليل مساحة العمل بأكملها وطرح أسئلة حول مواضيع الترميز ومفاهيم التكنولوجيا وممارسات البرمجة العامة.
الدردشة المضمنة: ابدأ جلسة دردشة مضمنة مباشرة من المحرر للسؤال عن أقسام تعليمات برمجية محددة.
الإجراءات الذكية: قم بتشغيل الإجراء الذكي Explain لشرح التعليمات البرمجية المحددة دون الحاجة إلى كتابة مطالبة.
دردشة سريعة: اطرح سؤالا سريعا وارجع إلى ما تقوم به.
إنشاء توثيق كود داخلي باستخدام GitHub Copilot
يمكن استخدام الميزات GitHub Copilot التالية لإنشاء توثيق الشيفرة الداخلية:
وضع السؤال: استخدم وضع السؤال للوكيل لاقتراح توثيق كود داخلي لملف كود أو فئة أو طريقة. راجع الوثائق المضمنة المقترحة في طريقة عرض الدردشة. طلب التحديثات حسب الحاجة في محادثة الدردشة. بمجرد أن تكون راضيا عن الوثائق المقترحة، يمكنك إدراج الوثائق المقترحة في ملف التعليمات البرمجية المقابل.
وضع الخطة: استخدم وضع الخطة لإنشاء خطة تنفيذ مفصلة لمهام التوثيق الخاصة بك. يمكن استخدام وضع الخطة لتحليل قاعدة الكود، وتحديد متطلبات التوثيق، وإعداد خطة خطوة بخطوة. بمجرد الموافقة على الخطة، يمكنك تسليمها إلى وضع الوكيل لتنفيذها.
وضع الوكيل: استخدم وضع الوكيل لتوليد وثائق الكود الداخلي بشكل مستقل لمشاريع أو ملفات أو فئات أو طرق محددة للكود. يجب على العامل تنفيذ مهام أخرى أثناء عملية الوثائق أو بعدها. قبول التحديثات أو رفضها عند إكمال العامل للمهام المعينة.
الدردشة المضمنة - استخدم جلسة دردشة مضمنة للعمل مباشرة في محرر التعليمات البرمجية. تكون الدردشة المضمنة مفيدة عندما تريد توثيق تعليمات برمجية معينة (الفئات أو الأساليب أو كتل التعليمات البرمجية) دون مغادرة المحرر. يمكنك تقديم تعليمات محددة في الطلب، يتم عرض التحديثات في محرر الكود ويمكن قبولها أو رفضها.
إنشاء توثيق المشروع باستخدام GitHub Copilot
يمكن استخدام الميزات GitHub Copilot التالية لإنشاء توثيق المشروع:
عرض الدردشة في وضع وكيل السؤال: استخدم وكيل السؤال لتحليل قاعدة الشيفرة وفهم مشاريع الكود والملفات والفئات. يمكن استخدام وكيل السؤال لمعاينة وثائق المشروع المقترحة. راجع الاقتراحات وطلب التحديثات أو التفاصيل الأخرى حسب الحاجة. إدراج الوثائق المقترحة في ملف وثائق المشروع (README.md).
عرض الدردشة في وضع وكيل الخطة: أنشئ خطة تنفيذ مفصلة لتوثيق المشروع، ثم سلمه إلى وضع الوكيل للتنفيذ.
عرض الدردشة في وضع الوكيل: إنشاء مجموعة من ملفات توثيق المشروع: إنشاؤ/تحديث README.md، إنشاء/تحديث UsageExamples.md، وإنشاء/تحديث ChangeLog.md. قم بتضمين ارتباطات بين ملفات الوثائق والفئات والأساليب ذات الإسناد الترافقي، وضمان التناسق عبر المستندات.
هام
عند استخدام عرض الدردشة في وضع الوكيل، كل طلب تدخله يحتسب كطلب مميز واحد، مضروبا في مضاعف النموذج. قد يتطلب GitHub Copilot عدة إجراءات متابعة لإكمال مهمتك، لكن هذه الإجراءات لا تحتسب ضمن استخدام طلبك المميز. فقط المحفزات التي تدخلها يتم تحميلها. إجمالي الطلبات المميزة المستخدمة يعتمد على عدد الطلبات التي تدخلها والنموذج الذي تختاره. الخطة المجانية GitHub Copilot تحصل على 50 طلب مميز شهريا. راجع وصف الخطط لمزيد من التفاصيل حول حدود طلبات الاشتراك المميزة لكل اشتراك GitHub Copilot.
ملخص
GitHub Copilot يساعدك على تحليل وتوثيق كودك بسرعة ودقة. توفر ميزات عرض الدردشة، والدردشة الداخلية، والدردشة السريعة، وميزات الإجراء الذكي مستويات مختلفة من التفاعل مباشرة داخل بيئة تعليمة Visual Studio برمجية.