افحص GitHub Copilot أفضل الممارسات

مكتمل

تساعد GitHub Copilot الإضافات ل Visual Studio Code المطورين على كتابة الكود بشكل أسرع وبأخطاء أقل.

ومع ذلك، GitHub Copilot مبرمج ذكاء اصطناعي وليس مبرمجا. للحصول على أقصى استفادة من الأدوات GitHub Copilot، عليك اتباع أفضل الممارسات.

اختر أداة GitHub Copilot المناسبة للمهمة

بينما تشترك ميزات إكمال الشيفرة في GitHub Copilot وميزات الدردشة في GitHub Copilot في بعض الوظائف، فإن الأداتين أفضل استخدامهما في ظروف مختلفة.

توفر عمليات إكمال التعليمات البرمجية أكبر قيمة عند استخدامها لما يلي:

• أكمل قصاصات التعليمات البرمجية وأسماء المتغيرات والوظائف أثناء كتابتها.
• إنشاء تعليمة برمجية متكررة.
• إنشاء تعليمة برمجية من التعليقات المضمنة باللغة الطبيعية.
• إنشاء اختبارات للتطوير القائم على الاختبار.

بدلا من ذلك، توفر ميزات الدردشة في GitHub Copilot أكبر قيمة عندما تعتاد على:

• أجب عن الأسئلة حول التعليمات البرمجية باللغة الطبيعية.
• إنشاء أقسام كبيرة من التعليمات البرمجية، ثم التكرار على تلك التعليمات البرمجية لتلبية احتياجاتك.
• إنجاز مهام محددة باستخدام الكلمات الأساسية والمهارات. يستخدم GitHub Copilot Chat كلمات مفتاحية مدمجة (ومهارات مصممة لتوفير سياقات مهمة) ضمن التعليمات لإنجاز المهام الشائعة بسرعة. أنواع مختلفة من الكلمات المفتاحية والمهارات متاحة في منصات الدردشة GitHub Copilot المختلفة.
• أكمل مهمة كشخصية معينة. على سبيل المثال، يمكنك أن تخبر GitHub Copilot Chat أنه مطور C++ كبير يهتم كثيرا بجودة الكود وسهولة القراءة والكفاءة. بعد تأسيس الشخصية، يمكنك طلب GitHub Copilot مراجعة الكود الخاص بك.

استفد إلى أقصى حد من GitHub Copilot الاقتراحات الداخلية

تقدم الإضافة GitHub Copilot اقتراحات تلقائيا لمساعدتك على البرمجة بشكل أكثر كفاءة. GitHub Copilot يقدم اقتراحات أفضل عندما تتبع بعض الأفعال والسلوكيات. قد تتبع بالفعل بعض هذه الإجراءات والسلوكيات، لأنها تساعدك أيضا وزملائك على فهم التعليمات البرمجية الخاصة بك.

قدم السياق GitHub Copilot

GitHub Copilot يعمل بشكل أفضل عندما يكون لديه سياق كاف لمعرفة ما تفعله وما الذي تريد المساعدة فيه. تماما كما تقدم لزميل السياق المناسب عند طلب المساعدة، عليك أيضا أن تقدم GitHub Copilot السياق.

فتح الملفات

بالنسبة لإكمال الكود، GitHub Copilot تنظر إلى الملفات المفتوحة في محررك لتحديد السياق وإنشاء اقتراحات مناسبة. وجود ملفات ذات صلة مفتوحة في عام Visual Studio Code أثناء استخدام GitHub Copilot يساعد في تحديد السياق ويسمح GitHub Copilot برؤية الصورة الأكبر لمشروعك.

تعليق المستوى الأعلى

تماما كما تعطي مقدمة موجزة وعالية المستوى لزميل في العمل، يمكن لتعليق علوي في ملف كود أن يساعد GitHub Copilot فهم السياق العام للكود الذي تنشئه.

المتضمنة والمراجع المناسبة

من الأفضل تعيين مراجع الوحدات النمطية أو المضمنة التي تحتاجها يدويا لعملك. GitHub Copilot يمكنه تقديم اقتراحات، لكنك على الأرجح تعرف أفضل ما هي الإدمانات التي يجب تضمينها. يمكن أن يعلم GitHub Copilot أيضا بالأطر والمكتبات وإصداراتها التي ترغب في استخدامها عند صياغة الاقتراحات.

أسماء دالات ذات معنى

تماما كما أن طريقة تسمى fetchData() لن تعني الكثير لزميل العمل (أو لك بعد عدة أشهر)، فإن fetchData() لن يساعدك GitHub Copilot على فهم كودك. استخدام أسماء الوظائف ذات معنى يساعد GitHub Copilot على توليد اقتراحات تفعل ما تريد.

تعليقات دالة محددة وجيدة النطاق

يمكن أن يكون اسم الدالة وصفيا للغاية فقط دون أن يكون طويلا للغاية. تعليقات الفعالية يمكن أن تساعد في ملء التفاصيل التي قد تحتاج GitHub Copilot معرفتها.

GitHub Copilot Prime مع كود نموذجي

إحدى الحيل للحصول على GitHub Copilot في الصفحة الصحيحة هي نسخ ولصق عينات الكود المرغوبة في تبويب محرر مفتوح. يجب أن تمثل العينة الكود الذي تريد GitHub Copilot محاكاته. تقديم مثال يمكن أن يساعد GitHub Copilot توليد اقتراحات تتناسب مع اللغة والمهام التي تريد أن يحاكها. بمجرد أن يساعدك GitHub Copilot في إنشاء كود يتناسب مع هدفك، يمكنك حذف الكود النموذجي. هذا النهج مفيد بشكل خاص عندما تحتاج إلى "تدريب" GitHub Copilot. على سبيل المثال، افترض أن GitHub Copilot تقترح مقتطفات كود تنفذ نسخة أقدم من مكتبة. يمكنك إدراج التعليمات البرمجية في مشروعك الذي يستخدم أحدث إصدار من المكتبة. يساعد هذا GitHub Copilot على البدء في اقتراح مقتطفات كود تستخدم أحدث إصدار من المكتبة. بمجرد أن يتعلم GitHub Copilot استخدام نسخة المكتبة الجديدة، يمكنك حذف الكود النموذجي.

كن متسقا واحتفظ بشريط الجودة عاليا

GitHub Copilot سيتمسك بالكود الخاص بك لتوليد اقتراحات تتبع النمط الحالي، لذا ينطبق مقولة "قمامة تدخل، خروجت قمامة".

الحفاظ دائما على شريط عالي الجودة يمكن أن يأخذ الانضباط. خاصة عندما تقوم بالترميز بسرعة وتحرر للحصول على شيء يعمل. قد ترغب في تعطيل GitHub Copilot الإكمال أثناء وضع "الاختراق". يمكنك تعطيل الإكمال مؤقتا من قائمة الحالة GitHub Copilot (يمكن الوصول إليها من شريط الحالة في Visual Studio Code).

استفد إلى أقصى حد من GitHub Copilot Chat

عند استخدام ميزات الدردشة في GitHub Copilot، هناك عدة أشياء يمكنك القيام بها لتحسين تجربتك.

ابدأ عام، ثم احصل على محدد

عند كتابة طلب GitHub Copilot، قدم GitHub Copilot وصفا عاما للهدف أو السيناريو. ثم سرد أي متطلبات محددة. خذ بعين الاعتبار المطالبات التالية:

1. اكتب دالة تخبرني إذا كان الرقم أوليا.
2. يجب أن تأخذ الدالة عددا صحيحا وترجع true إذا كان العدد الصحيح أوليا.
3. يجب أن تطرح الدالة خطأ إذا لم يكن الإدخال عددا صحيحا موجبا.

تقديم أمثلة

استخدم أمثلة لمساعدتك GitHub Copilot فهم ما تريد. يمكنك توفير مثال لبيانات الإدخال، ومثال على المخرجات، ومثال على عمليات التنفيذ.

تقسيم المهام المعقدة إلى مهام أبسط

إذا كنت تريد GitHub Copilot إكمال مهمة معقدة أو كبيرة، فقسم المهمة إلى عدة مهام بسيطة وصغيرة. على سبيل المثال، بدلا من طلب GitHub Copilot إنشاء لغز بحث عن كلمات، قسم العملية إلى مهام أصغر، واطلب GitHub Copilot إنجازها واحدة تلو الأخرى:

1. اكتب دالة لإنشاء شبكة أحرف 10 ب 10.
2. اكتب دالة للعثور على كل الكلمات في شبكة من الأحرف، مع إعطاء قائمة بالكلمات الصالحة.
3. اكتب دالة تستخدم الدالات السابقة لإنشاء شبكة من الأحرف من 10 إلى 10 تحتوي على 10 كلمات على الأقل.
4. قم بتحديث الدالة السابقة لطباعة شبكة الأحرف و10 كلمات عشوائية من الشبكة.

تجنب الغموض

تجنب المصطلحات الغامضة. على سبيل المثال، لا تسأل "ماذا يفعل هذا" عندما يكون "هذا" هو الملف الحالي، أو آخر رد GitHub Copilot، أو كتلة كود محددة. بدلا من استخدام مصطلحات غامضة، كن محددا: ماذا تفعل دالة createUser؟

الإشارة إلى التعليمات البرمجية ذات الصلة

إذا كنت تستخدم GitHub Copilot Chat في بيئة التطوير الخاصة بك، افتح الملف/الملفات أو حدد الكود الذي تريد GitHub Copilot الرجوع إليه. استخدم المشاركين في الدردشة والأوامر المائلة ومتغيرات الدردشة في المطالبات لتعريف السياق. على سبيل المثال، حدد الملفات التي يجب GitHub Copilot الإشارة إليها Chat.

استخدام المشاركين في الدردشة والأوامر المائلة ومتغيرات الدردشة

تم تصميم المشاركين في الدردشة لجمع سياق إضافي إما حول قاعدة تعليمات برمجية أو مجال أو تقنية محددة. عندما تحدد المشارك المناسب، يمكن GitHub Copilot Chat العثور على معلومات أفضل وتقديمها لإرسالها إلى الواجهة الخلفية GitHub Copilot. على سبيل المثال، استخدم @workspace عند طرح أسئلة عن مشروعك المفتوح، أو @vscode عند طرح أسئلة عن ميزات Visual Studio Code وواجهات برمجة التطبيقات.

أوامر Slash تساعد GitHub Copilot الدردشة على فهم نيتك عند طرح سؤال. هل تتعلم عن قاعدة كود (/explain)، هل تريد مساعدة في إصلاح مشكلة ()،/fix أم أنك تنشئ حالات اختبار (/tests)؟ من خلال إبلاغ GitHub Copilot Chat بما تحاول فعله، يمكنه ضبط رده على مهمتك وتقديم أوامر وإعدادات ومقتطفات كود مفيدة.

يمكن للمشاركين في الدردشة، مثل @workspace أو @vscode، المساهمة بمتغيرات الدردشة التي توفر سياقا خاصا بالنطاق. يمكنك الإشارة إلى متغير الدردشة في موجه الدردشة باستخدام الرمز # . يمكنك استخدام متغيرات الدردشة لتكون أكثر تحديدا حول سياق المطالبة.

على سبيل المثال، #file متغير الدردشة يتيح لك الإشارة إلى ملفات محددة من مساحة العمل في موجه الدردشة. هذا يساعد في جعل الإجابات من GitHub Copilot Chat أكثر صلة بكودك من خلال توفير سياق حول الملف الذي تعمل عليه. يمكنك طرح أسئلة مثل "Can you suggest improvements to #file:package.json?" أو "How do I add an extension in #file:devcontainer.json?". استخدام متغير #file يمكن أن يساعدك في الحصول على ردود أكثر استهدافا ودقة من GitHub Copilot.

التجربة والتكرار

إذا لم تحصل على النتيجة التي تريدها، فقم بالتكرار على المطالبة وحاول مرة أخرى. الرجوع إلى الاستجابة السابقة في طلبك التالي. يمكنك أيضا حذف الاستجابة السابقة والبدء من جديد.

الحفاظ على المحفوظات ذات الصلة

يستخدم GitHub Copilot Chat سجل الدردشة للحصول على سياق حول طلبك. للتأكد من أن GitHub Copilot يستخدم سجل دردشة ذي صلة:

• استخدم مؤشرات الترابط لبدء محادثة جديدة لمهمة جديدة.
• احذف الطلبات التي لم تعد ذات صلة أو التي لم تمنحك النتيجة المطلوبة.

اتباع ممارسات الترميز الجيدة

إذا لم تحصل على الردود التي تريدها عند طلب GitHub Copilot اقتراحات، تأكد من أن الكود الحالي لديك يتبع أفضل الممارسات وسهل القراءة. على سبيل المثال:

• استخدم نمط وأنماط تعليمات برمجية متناسقة.
• استخدم أسماء وصفية للمتغيرات والدالات.
• على التعليمات البرمجية الخاصة بك.
• بنية التعليمات البرمجية الخاصة بك إلى مكونات نمطية محددة النطاق.
• تضمين اختبارات الوحدة.

الملخص

GitHub Copilot أداة قوية يمكنها مساعدتك في كتابة الكود بشكل أسرع وبأخطاء أقل. ومع ذلك، للحصول على أقصى استفادة من GitHub Copilot، عليك اتباع أفضل الممارسات. من خلال اختيار أداة GitHub Copilot المناسبة للعمل، وتوفير السياق، واتباع ممارسات برمجية جيدة، يمكنك تحسين تجربتك مع GitHub Copilot.