सर्वोत्तम प्रथाओं GitHub Copilot जांच करें

  • 8 मिनट्स

Visual Studio Code के लिए GitHub Copilot एक्सटेंशन डेवलपर्स को तेजी से और कम त्रुटियों के साथ कोड लिखने में मदद करते हैं।

हालाँकि, GitHub Copilot एक AI पेयर प्रोग्रामर है, तो यह प्रोग्रामर नहीं है। GitHub Copilot उपकरणों का अधिकतम लाभ उठाने के लिए, आपको सर्वोत्तम प्रथाओं का पालन करने की आवश्यकता है।

नौकरी के लिए सही GitHub Copilot टूल चुनें

जबकि GitHub Copilot की कोड पूर्णता सुविधाएँ और GitHub Copilot की चैट सुविधाएँ कुछ कार्यक्षमता साझा करती हैं, दोनों टूल अलग-अलग परिस्थितियों में सबसे अच्छा उपयोग किए जाते हैं।

कोड पूर्णताएं सबसे अधिक मूल्य प्रदान करती हैं जब उनका उपयोग किया जाता है:

  • कोड स्निपेट, चर नाम और फ़ंक्शन को पूरा करें जैसे आप उन्हें लिखते हैं।
  • दोहराव कोड उत्पन्न करें।
  • प्राकृतिक भाषा में इनलाइन टिप्पणियों से कोड उत्पन्न करें।
  • परीक्षण-संचालित विकास के लिए परीक्षण उत्पन्न करें।

वैकल्पिक रूप से, GitHub Copilot की चैट सुविधाएँ सबसे अधिक मूल्य प्रदान करती हैं जब वे इसके लिए उपयोग की जाती हैं:

  • प्राकृतिक भाषा में कोड के बारे में सवालों के जवाब दें।
  • कोड के बड़े खंड उत्पन्न करें, फिर अपनी आवश्यकताओं को पूरा करने के लिए उस कोड पर पुनरावृति करें।
  • कीवर्ड और कौशल के साथ विशिष्ट कार्यों को पूरा करें। GitHub Copilot Chat सामान्य कार्यों को शीघ्रता से पूरा करने के लिए संकेतों के भीतर अंतर्निहित कीवर्ड (और महत्वपूर्ण संदर्भ प्रदान करने के लिए डिज़ाइन किए गए कौशल) का उपयोग करता है। विभिन्न प्रकार के कीवर्ड और कौशल विभिन्न GitHub Copilot चैट प्लेटफ़ॉर्म में उपलब्ध हैं।
  • एक विशिष्ट व्यक्तित्व के रूप में एक कार्य पूरा करें। उदाहरण के लिए, आप चैट GitHub Copilot बता सकते हैं कि यह एक वरिष्ठ C++ डेवलपर है जो कोड की गुणवत्ता, पठनीयता और दक्षता की बहुत परवाह करता है। व्यक्तित्व स्थापित करने के बाद, आप GitHub Copilot अपने कोड की समीक्षा करने के लिए कह सकते हैं।

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 उन रूपरेखाओं, पुस्तकालयों और उनके संस्करणों के बारे में भी सूचित कर सकता है जिनका उपयोग आप सुझाव तैयार करते समय करना चाहते हैं।

अर्थपूर्ण फ़ंक्शन नाम

जिस तरह fetchData() नामक एक विधि किसी सहकर्मी (या कई महीनों के बाद) के लिए बहुत मायने नहीं रखती है, उसी तरह fetchData() GitHub Copilot आपके कोड को समझने में मदद नहीं करेगा। सार्थक फ़ंक्शन नामों का उपयोग करने से GitHub Copilot सुझाव उत्पन्न करने में मदद मिलती है जो आप चाहते हैं।

विशिष्ट और अच्छी तरह से स्कोप किए गए फ़ंक्शन टिप्पणियाँ

एक फ़ंक्शन नाम केवल इतना वर्णनात्मक हो सकता है कि अत्यधिक लंबा न हो। फ़ंक्शन टिप्पणियाँ उन विवरणों को भरने में मदद कर सकती हैं जिन्हें GitHub Copilot जानने की आवश्यकता हो सकती है।

नमूना कोड के साथ प्राइम GitHub Copilot

सही पृष्ठ पर 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 चैट का अधिकतम लाभ उठाएं

जब आप GitHub Copilot की चैट सुविधाओं का उपयोग कर रहे हों, तो आप अपने अनुभव को अनुकूलित करने के लिए कई चीजें कर सकते हैं।

सामान्य शुरू करें, फिर विशिष्ट हो जाएं

GitHub Copilot के लिए प्रॉम्प्ट लिखते समय, पहले GitHub Copilot लक्ष्य या परिदृश्य का व्यापक विवरण दें। फिर किसी भी विशिष्ट आवश्यकताओं को सूचीबद्ध करें। निम्नलिखित संकेतों पर विचार करें:

  1. एक फ़ंक्शन लिखें जो मुझे बताता है कि कोई संख्या प्राइम है या नहीं।
  2. फ़ंक्शन को एक पूर्णांक लेना चाहिए और पूर्णांक अभाज्य होने पर सत्य लौटना चाहिए।
  3. यदि इनपुट सकारात्मक पूर्णांक नहीं है तो फ़ंक्शन को एक त्रुटि फेंकनी चाहिए।

उदाहरण दीजिए

आप जो चाहते हैं उसे समझने में GitHub Copilot में मदद के लिए उदाहरणों का उपयोग करें। आप उदाहरण इनपुट डेटा, उदाहरण आउटपुट और उदाहरण कार्यान्वयन प्रदान कर सकते हैं।

जटिल कार्यों को सरल कार्यों में विभाजित करें

यदि आप किसी जटिल या बड़े कार्य को पूरा करना चाहते GitHub Copilot, तो कार्य को कई सरल, छोटे कार्यों में विभाजित करें। उदाहरण के लिए, GitHub Copilot शब्द खोज पहेली उत्पन्न करने के लिए कहने के बजाय, प्रक्रिया को छोटे कार्यों में विभाजित करें, और GitHub Copilot उन्हें एक-एक करके पूरा करने के लिए कहें:

  1. अक्षरों के 10 बाय 10 ग्रिड उत्पन्न करने के लिए एक फ़ंक्शन लिखें।
  2. अक्षरों के ग्रिड में सभी शब्दों को खोजने के लिए एक फ़ंक्शन लिखें, मान्य शब्दों की एक सूची दी गई है।
  3. एक फ़ंक्शन लिखें जो पिछले कार्यों का उपयोग करके अक्षरों के 10 से 10 ग्रिड उत्पन्न करता है जिसमें कम से कम 10 शब्द होते हैं।
  4. ग्रिड से अक्षरों और 10 यादृच्छिक शब्दों के ग्रिड को प्रिंट करने के लिए पिछले फ़ंक्शन को अपडेट करें।

अस्पष्टता से बचें

अस्पष्ट शब्दों से बचें। उदाहरण के लिए, "यह क्या करता है" न पूछें जब "यह" वर्तमान फ़ाइल, अंतिम GitHub Copilot प्रतिक्रिया या एक विशिष्ट कोड ब्लॉक हो सकता है। अस्पष्ट शब्दों का उपयोग करने के बजाय, विशिष्ट रहें: createUser फ़ंक्शन क्या करता है?

प्रासंगिक कोड इंगित करें

अगर आप अपने IDE में GitHub Copilot Chat का इस्तेमाल कर रहे हैं, तो फ़ाइल खोलें या उस कोड को हाइलाइट करें जिसका आप GitHub Copilot रेफर करना चाहते हैं. संदर्भ को परिभाषित करने के लिए संकेतों में चैट प्रतिभागियों, स्लैश कमांड और चैट चर का उपयोग करें। उदाहरण के लिए, निर्दिष्ट करें कि GitHub Copilot चैट को किन फ़ाइलों का संदर्भ देना चाहिए।

चैट प्रतिभागियों, स्लैश आदेशों और चैट वैरिएबल का उपयोग करें

चैट प्रतिभागियों को कोड बेस या विशिष्ट डोमेन या तकनीक के बारे में अतिरिक्त संदर्भ एकत्र करने के लिए डिज़ाइन किया गया है। जब आप उपयुक्त प्रतिभागी निर्दिष्ट करते हैं, तो GitHub Copilot Chat GitHub Copilot बैकएंड पर भेजने के लिए बेहतर जानकारी ढूंढ सकता है और प्रदान कर सकता है। उदाहरण के लिए, जब आप अपने खुले प्रोजेक्ट के बारे में प्रश्न पूछते हैं तो @workspace का उपयोग करें, या जब आप Visual Studio Code सुविधाओं और API के बारे में प्रश्न पूछते हैं तो @vscode का उपयोग करें।

स्लैश कमांड 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 के साथ अपने अनुभव को अनुकूलित कर सकते हैं।