إنشاء توثيق كود داخلي باستخدام GitHub Copilot
يؤدي توثيق التعليمات البرمجية بشكل صحيح إلى إنشاء قاعدة تعليمات برمجية أكثر قابلية للقراءة وقابلة للصيانة يسهل على المطورين الآخرين فهمها والعمل معها.
يمكن ل GitHub Copilot Chat مساعدتك في توثيق الكود بسرعة ودقة وبشكل متسق.
يمكن استخدام كل من ميزات GitHub Copilot التالية لإنشاء وثائق كود داخلية:
- عرض الدردشة: استخدم عرض الدردشة في وضع السؤال أو الوكيل أو الخطة.
- الدردشة المضمنة: استخدم جلسة دردشة مضمنة لتوثيق تعليمات برمجية محددة (فئات أو أساليب أو كتل تعليمات برمجية) دون مغادرة المحرر.
إنشاء وثائق التعليمات البرمجية المضمنة باستخدام طريقة عرض الدردشة
يمكن استخدام طريقة عرض الدردشة لإنشاء وثائق التعليمات البرمجية المضمنة لمشروع أو ملف تعليمة برمجية أو فئة أو أسلوب. يمكنك مراجعة الوثائق المقترحة وطلب التحديثات حسب الحاجة قبل تحديث ملف التعليمات البرمجية.
يمكن استخدام كل من الأوضاع الثلاثة في عرض الدردشة (اسأل، وكيل، وخطة) لإنشاء وثائق كود داخلية. تكلفة استخدام وضع العامل أعلى من الأوضاع الأخرى، والتي قد تكون أحد الاعتبارات.
إنشاء وثائق التعليمات البرمجية المضمنة باستخدام طريقة عرض الدردشة في وضع الطلب
يمكن استخدام وضع الطلب لتقييم التعليمات البرمجية واقتراح وثائق التعليمات البرمجية المضمنة للمشاريع أو الفئات أو الأساليب. يمكنك مراجعة الوثائق المضمنة المقترحة وإنشاء التحديثات حسب الحاجة قبل إضافة الوثائق إلى ملف التعليمات البرمجية.
افتح طريقة عرض الدردشة في وضع الطلب.
إضافة سياق إلى موجه الدردشة. على سبيل المثال، أضف ملف markdown الذي يوفر إرشادات الوثائق.
أدخل مطالبة لإنشاء وثائق التعليمات البرمجية المضمنة. على سبيل المثال، يمكنك إدخال المطالبة التالية:
Suggest inline code documentation for the ConsoleApp class.راجع وثائق التعليمات البرمجية المضمنة المقترحة في طريقة عرض الدردشة.
بمجرد أن تكون راضيا عن الوثائق المقترحة، يمكنك تطبيق الوثائق المقترحة في ملف التعليمات البرمجية المقابل.
مرر مؤشر الفأرة فوق الوثائق المقترحة لرؤية أزرار التطبيق في المحرر، الإدراج عند المؤشر، والنسخ . يستخدم زر التطبيق في المحرر لتطبيق الوثائق المقترحة على ملف الكود.
يمكنك استخدام زر الإدراج في المؤشر لإدخال الاقتراح في المحرر في موقع المؤشر الحالي، أو زر النسخ لنسخ الاقتراح إلى الحافظة.
بعد تطبيق الوثائق المقترحة على ملف التعليمات البرمجية، يمكنك التنقل عبر التحديثات لقبول الاقتراحات الفردية أو رفضها أو تعديلها.
استخدم السهمين لأعلى ولأسفل على شريط القوائم السفلي للتنقل عبر التحديثات المقترحة.
أثناء التنقل عبر الاقتراحات، يمكنك الاحتفاظ بالاقتراحات الفردية أو التراجع فيها باستخدام القائمة المنبثقة التي تظهر عند تمرير الماوس فوق الاقتراح.
يمكنك أيضا تعديل الاقتراحات يدويا حسب الحاجة.
لقبول أو رفض جميع الاقتراحات، اختر زر الاحتفاظ أو التراجع في أسفل شريط القائمة.
يمكنك متابعة تحديث الوثائق حسب الحاجة في محرر التعليمات البرمجية.
إنشاء توثيق كود داخلي باستخدام عرض الدردشة في وضع الخطة
يمكن استخدام عرض الدردشة في وضع الخطة لإنشاء خطة مفصلة لإنشاء توثيق كود مدمني عبر مشروعك. يقوم وضع الخطة بتحليل قاعدة الكود الخاصة بك وإنتاج خطة خطوة بخطوة يمكن تسليمها إلى وضع الوكيل للتنفيذ.
افتح عرض الدردشة في وضع الخطة.
أدخل طلبا يصف مهام التوثيق الداخلي الخاص بك.
على سبيل المثال، يمكنك إدخال المطالبة التالية:
Create a plan for adding inline code documentation to the codebase. Document classes, properties, and methods. Identify all files that need documentation updates.راجع خطة التنفيذ.
بعد لحظات، يعرض وكيل الخطة خطة في عرض الدردشة. توفر الخطة ملخصا عاما وتفصيلا للخطوات، بما في ذلك أي أسئلة مفتوحة للتوضيح.
بمجرد اكتمال الخطة، اختر بدء التنفيذ لتسليم الخطة إلى وضع الوكيل، أو اختر فتح في المحرر لحفظ الخطة كملف Markdown للاستخدام لاحقا.
عند اختيار بدء التنفيذ، ينتقل GitHub Copilot إلى وضع الوكيل ويبدأ في إضافة وثائق الكود الداخلي بناء على الخطة المعتمدة.
راجع الملفات المحدثة في المحرر. انتقل عبر التحديثات لقبول الاقتراحات الفردية أو رفضها أو تعديلها.
لقبول أو رفض جميع الاقتراحات، اختر زر الاحتفاظ أو التراجع في أسفل شريط القائمة. يمكنك أيضا اختيار أزرار الاحتفاظ أو التراجع في عرض الدردشة لقبول أو رفض جميع الاقتراحات.
يمكنك متابعة تحديث الوثائق حسب الحاجة في محرر التعليمات البرمجية.
إنشاء وثائق التعليمات البرمجية المضمنة باستخدام طريقة عرض الدردشة في وضع العامل
يمكن استخدام طريقة عرض الدردشة في وضع العامل لإنشاء وثائق التعليمات البرمجية المضمنة لمشروع أو ملف تعليمة برمجية أو فئة أو أسلوب. يمكنك مراجعة الوثائق المضمنة المقترحة وطلب التحديثات حسب الحاجة قبل تحديث ملف التعليمات البرمجية.
افتح طريقة عرض الدردشة في وضع العامل.
إضافة سياق إلى موجه الدردشة. على سبيل المثال، استخدم زر Attach Context (أيقونة مشبك الورق) لإضافة مجلدات الشيفرة المصدرية إلى الدردشة.
أدخل مطالبة تحدد مهام الوثائق.
على سبيل المثال، يمكنك إدخال المطالبة التالية:
Create inline code documentation for all C# class files in the specified context. Document the class, properties, and methods. Do not add documentation to JSON, markdown, or other file types. Do not document UnitTest project files in the Test folder. Ensure that the solution builds without errors after the documentation is added.يعرض العامل رسائل الحالة في طريقة عرض الدردشة أثناء إكمال المهام المطلوبة.
قد يطلب العامل أيضا مزيدا من السياق أو يطلب المساعدة لإكمال المهام المطلوبة. على سبيل المثال، قد يطلب العامل الإذن قبل تشغيل أمر في المحطة الطرفية.
انتظر حتى يكمل العامل مهام الوثائق المطلوبة، ثم راجع الملفات المحدثة التي قام المحرر بها.
عند الانتهاء من وضع العامل، فإنه يعرض ملخصا للمهام التي أكملها. يمكنك مراجعة الملفات المحدثة في المحرر.
انتقل عبر التحديثات لقبول الاقتراحات الفردية أو رفضها أو تعديلها.
لقبول أو رفض جميع الاقتراحات، اختر زر الاحتفاظ أو التراجع في أسفل شريط القائمة. يمكنك أيضا اختيار أزرار الاحتفاظ أو التراجع في عرض الدردشة لقبول أو رفض جميع الاقتراحات.
يمكنك متابعة تحديث الوثائق حسب الحاجة في محرر التعليمات البرمجية.
إنشاء وثائق التعليمات البرمجية المضمنة باستخدام الدردشة المضمنة
يمكن استخدام ميزة الدردشة المضمنة لإنشاء وثائق التعليمات البرمجية المضمنة للفئات أو الأساليب أو كتل التعليمات البرمجية المعقدة. يتم استخدام المطالبة لتحديد سياق أو لتوفير إرشادات محددة.
تقترح الدردشة المضمنة وثائق التعليمات البرمجية المضمنة مباشرة في محرر التعليمات البرمجية.
افتح ملف التعليمات البرمجية في المحرر.
حدد التعليمات البرمجية التي تريد توثيقها.
بدء جلسة دردشة مضمنة.
استخدم اختصار لوحة مفاتيح Ctrl+I أو اختر فتح الدردشة الداخلية من قائمة الدردشة .
أدخل مطالبة لإنشاء وثائق التعليمات البرمجية المضمنة.
على سبيل المثال، يمكنك توثيق أسلوب وطلب تفاصيل محددة:
Document the selected method. List currentState optionsراجع وثائق التعليمات البرمجية المضمنة المقترحة في المحرر.
استخدم زر الاحتفاظ بقبول التحديث المقترح أو التراجع لرفض التحديث.
ملخص
يساعدك GitHub Copilot على إنشاء توثيق الكود الداخلي بسرعة ودقة. توفر ميزات عرض الدردشة والدردشة الداخلية مستويات مختلفة من التفاعل مباشرة داخل بيئة تعليمة Visual Studio برمجية.