Luo tehokkaita kehotuksia GitHub Copilotille

8 minuuttia

prompt on luonnollisen kielen opetus, joka kertoo GitHub Copilot, mitä haluat sen tekevän. Kehotteita voidaan käyttää kysymysten esittämiseen, pyyntöjen välittämiseen tai tehtävien kuvaamiseen.

Esimerkiksi seuraavat kehotteet edustavat kysymystä, pyyntöä ja tehtävän kuvausta.

Question: How do I create a button that submits a form?

Request: Add a button that opens a modal dialog. The button should be blue with rounded corners.

Task: Build a product page that displays a product title, product image, product description, and price. Product information should be fetched from the attached ProductsList.json file. The price should be formatted as currency. The page should also include a button to add the product to the cart.

Kehotteesi laatu vaikuttaa suoraan GitHub Copilot -vastauksen laatuun.

Millainen on hyvä kehote?

Laadukkaiden kehotteiden luominen on olennaista, jotta saat mahdollisimman paljon arvoa GitHub Copilotista. Seuraavat strategiat auttavat sinua luomaan kehotteita, jotka tuottavat tarkempia, osuvampia ja hyödyllisempiä vastauksia.

Aloita yleiset ja hanki sitten tarkempi

Kun kirjoitat Copilot-aihetta, aloita laajalla kuvauksella tavoitteestasi tai tilanteestasi ja anna sitten tarkat vaatimukset. Tämä lähestymistapa antaa Copilot'lle tarvittavan kontekstin ja varmistaa, että yksityiskohtaiset tarpeesi huomioidaan.

Example:

Write a function that tells me if a number is prime.

The function should take an integer and return true if the integer is prime.

The function should error if the input is not a positive integer.

Anna konkreettisia esimerkkejä

Esimerkit ovat yksi tehokkaimmista tavoista viestiä aikomuksesi Copilotille. Voit antaa esimerkkejä syötetiedoista, odotetuista tuotoksista ja jopa esimerkkitoteutuksista, jotka ohjaavat tekoälyn ymmärtämistä.

Example:

Write a function that finds all dates in a string and returns them in an array. Dates can be formatted like:

- 05/02/24
- 05/02/2024
- 5/2/24
- 5/2/2024
- 05-02-24
- 05-02-2024
- 5-2-24
- 5-2-2024

Example usage:
findDates("I have a dentist appointment on 11/14/2023 and book club on 12-1-23")

Expected return: ["11/14/2023", "12-1-23"]

Jaa monimutkaiset tehtävät yksinkertaisempiin vaiheisiin

Kun kohtaat monimutkaisen tai suuren tehtävän, hajota se pienemmiksi, hallittavissa oleviksi komponenteiksi. Tämä lähestymistapa johtaa parempiin tuloksiin ja helpottaa yksittäisten osien virheenkorjausta ja tarkentamista.

Esimerkki: Sen sijaan, että pyytäisit Copilot luomaan täydellisen sanahakupulman, pilko se osiin:

Write a function to generate a 10 by 10 grid of letters
Write a function to find all words in a grid of letters, given a list of valid words
Write a function that uses the previous functions to generate a 10 by 10 grid containing at least 10 words
Update the previous function to print the grid and 10 random words from the grid

Poista epäselvyydet

Vältä epämääräisiä viittauksia ja moniselitteisiä termejä, jotka voidaan tulkita monella tavalla. Ole selkeä siitä, mihin viittaat ja mitä haluat Copilot'n tekevän.

Huonoja esimerkkejä:

"Mitä tämä tekee?" (epäselvää, mihin "tämä" viittaa).
"Korjaa virhe" (ei määrittele mikä virhe tai miten se korjataan).

Parempia esimerkkejä:

"Mitä createUser-funktio tekee?"
"Mitä viimeisimmän vastauksesi koodi tekee?"
"Korjaa vahvistusvirhe sähköpostin syöttökentässä."

Kirjastoon liittyviä seikkoja:

Jos käytät harvinaista kirjastoa, kuvaile sen tarkoitusta.
Sisällytä tietyissä kirjastoissa import-lausekkeet tai määritä, mitä kirjastoa haluat käyttää.

Tarjoa asiaankuuluva konteksti

Auta Copilot ymmärtämään projektirakenteesi ja aikomuksensa hallitsemalla kehitysympäristöäsi tehokkaasti.

IDE:ssä:

Avaa asiaankuuluvat tiedostot ja sulje asiaankuulumattomat.
Korosta tiettyjä koodiosia, joihin haluat Copilot viittaavan.
Käytä Lisää konteksti -painiketta Chat-näkymässä liittääksesi tiettyjä tiedostoja, symboleja tai työtilan sisältöä.
Viittaa kontekstiin suoraan kehotteessasi - #viitteillä kuten #file ja #selection.

In Copilot Chat:

Viittaa tiettyihin tiedostoihin tai koodilohkoihin.
Liitä mukaan asiaankuuluvat asiakirjat tai tekniset tiedot.
Käytä selkeitä tiedostopolkuja ja funktioiden nimiä.

Iteroi ja tarkenna

Älä odota täydellisiä tuloksia ensimmäisellä yrittämällä. Copilot toimii parhaiten, kun käydään iteratiivista keskustelua ja hiot pyyntöjäsi saamiesi vastausten perusteella.

Iteraatiostrategiat:

Jos käytät sisäisiä ehdotuksia, poista ne ja yritä uudelleen muokatulla kehotteella.
Copilot Chat -osiossa viittaa aiempiin vastauksiin ja pyydä tarkkoja muutoksia.
Rakenna osittaisia ratkaisuja pyytämällä asteittaisia parannuksia.

Ylläpidä asiaankuuluvaa keskusteluhistoriaa

Copilot Chat käyttää keskusteluhistoriaa kontekstin ymmärtämiseen, joten hallinnoi tätä historiaa strategisesti.

Parhaat käytännöt:

Aloita uusia ketjuja eri tehtäviin tai projekteihin.
Poista epäolennaiset tai epäonnistuneet pyynnöt, jotka saattavat hämmentää tulevia vastauksia.
Pidä keskustelut keskittyneinä aiheeseen liittyviin toimintoihin.

Seuraa hyviä koodauskäytäntöjä

Nykyisen koodipohjasi laatu vaikuttaa Copilot'n kykyyn tuottaa sopivia ehdotuksia. Ylläpidä korkeita standardeja koodissasi saadaksesi parempaa tekoälyapua.

Koodin laatutekijät:

Käytä yhtenäistä koodityyliä ja -malleja.
Valitse muuttujille ja funktioille kuvaavat nimet.
Lisää merkityksellisiä kommentteja monimutkaisen logiikan selittämiseksi.
Rakenna koodi modulaarisiksi, hyvin laajennetuiksi komponenteiksi.
Sisällytä kattavat yksikkötestit.

Note

Voit pyytää Copilotia parantamaan koodisi laatua pyytämällä kommentteja, refaktoroimalla ehdotuksia tai jakamalla suuret toiminnot pienempiin, helpommin hallittaviin osiin.

Hyviä kehotteita ovat:

Selkeä: Kuvaile tarkalleen, mitä haluat.
Erityiset: Sisällytä asettelu-, toiminta- tai tyylitiedot.
Tilannekohtainen: Viittaa olemassa olevaan koodiin tai rakenteeseen.

Kehotteiden iterointi

Jos GitHub Copilot ei vastaa odotuksiasi, saatat joutua kehittämään kehotustasi. Harkitse näitä strategioita:

Muokkaa kehotetta tarkemmaksi.
Lisää chattiin konteksti, joka selventää tavoitteitasi tai vaatimuksiasi.
Käytä Copilot Chat -ohjelmaa esittääksesi jatkokysymyksiä, jotka perustuvat aiempiin vastauksiin.

Copilot'n ehdotusten arviointi ja niihin vastaaminen

Copilot'n ehdotusten arviointi on ratkaisevan tärkeää tehokkaan vibra-koodauksen kannalta. Kaikki ehdotukset eivät ole täydellisiä, ja kun tiedät, milloin hyväksyä, hylätä tai muokata vastauksia, parantaa merkittävästi kehityskokemustasi.

Milloin ehdotuksia kannattaa hyväksyä?

Hyväksy Copilot'n ehdotukset, kun he:

Täytä vaatimuksesi: Koodi tekee juuri sen, mitä pyysit.
Noudata parhaita käytäntöjä: Käyttää asianmukaisia malleja, nimeämiskäytäntöjä ja rakennetta.
Ovat hyvin jäsenneltyjä: Koodi on luettavissa, ylläpidettävissä ja oikein muotoiltu.
Sisällytä asianmukainen virheenkäsittely: Reunatapaukset ja mahdolliset viat korjataan.
Vastaa projektisi tyyliä: Vastaa olemassa olevia koodipohjamalleja ja käytäntöjä.

Esimerkki hyvästä ehdotuksesta hyväksyttäväksi:

Ripeä: "Luo toiminto sähköpostiosoitteiden vahvistamiseksi"

Copilot ehdottaa:

function validateEmail(email) {
    const emailRegex = /^[^\s@]+@[^\s@]+\.[^\s@]+$/;
    if (typeof email !== 'string') {
        throw new Error('Email must be a string');
    }
    return emailRegex.test(email.toLowerCase());
}

Tämä ehdotus tulee hyväksyä, koska se sisältää syötteen validoinnin, virheiden käsittelyn ja käyttää kohtuullista säännöllistä lausekemallia.

Milloin ehdotukset hylätään?

Hylkää Copilot'n ehdotukset, kun he:

Älä vastaa kehotteeseen: Koodi ratkaisee eri ongelman kuin pyydettiin.
Sisältää tietoturva-aukkoja: Käytä vaarallisia käytäntöjä tai paljasta arkaluonteisia tietoja.
Ovat liian monimutkaisia: Yksinkertaiset tehtävät, jotka toteutetaan tarpeettoman monimutkaisesti.
Käytä vanhentuneita menetelmiä: Luota vanhentuneisiin tai vanhentuneisiin ohjelmointirajapintoihin.
Virheiden käsittely puuttuu: Älä ota huomioon mahdollisia vikaskenaarioita.
Koodausstandardien rikkominen: Älä noudata tiimisi vakiintuneita käytäntöjä.

Esimerkki hylkäämisehdotuksesta:

Ripeä: "Luo suojattu salasanan vahvistustoiminto"

Huono ehdotus:

function validatePassword(password) {
    return password.length > 6;
}

Tämä tulee hylätä, koska se on liian yksinkertainen turvallisuusvaatimuksiin nähden eikä vahvista salasanan vahvuutta kunnolla.

Milloin ehdotuksia kannattaa muokata?

Muokkaa Copilotin ehdotuksia, kun he:

Ovat enimmäkseen oikein, mutta vaativat säätöjä: Ydinlogiikka on kunnossa, mutta yksityiskohdat kaipaavat säätöä.
Tarvitsetko lisäominaisuuksia: Perustoiminnallisuus on hyvä, mutta vaatii parannuksia.
Pieniä tyyliongelmia: Koodi toimii, mutta ei vastaa muotoiluasetuksiasi.
Vaadi eri muuttujanimiä: Logiikka on oikea, mutta nimeämistä voisi parantaa.
Tarvitset suorituskyvyn optimointia: Toimiva, mutta voisi olla tehokkaampi.

Esimerkki muutosehdotuksesta:

Copilot ehdottaa:

function calculateTotal(items) {
    let total = 0;
    for (let i = 0; i < items.length; i++) {
        total += items[i].price;
    }
    return total;
}

Muokkauksesi luettavuuden parantamiseksi ja nykyaikaiseksi JavaScriptiksi:

function calculateTotal(items) {
    return items.reduce((total, item) => total + item.price, 0);
}

Strategiat ehdotusten parantamiseksi

Jos ehdotus ei ole aivan oikea, kokeile näitä lähestymistapoja:

Tarkenna kehotetta:

Lisää tarkempia vaatimuksia.
Sisällytä esimerkkejä odotetuista panoksista/tuotoksista.
Määritä käyttämäsi ohjelmointityyli tai kehys.

Pyydä muutoksia:

"Tee edellisestä funktiosta kestävämpi virheenkäsittelyllä."
"Yksinkertaista juuri kirjoittamaasi koodia."
"Lisää TypeScript-tyyppejä edelliseen funktioon."

Rakenna asteittain:

Aloita perusversiosta ja pyydä parannuksia.
Lisää ominaisuuksia yksi kerrallaan sen sijaan, että pyytäisit kaikkea kerralla.
Testaa jokainen iteraatio ennen kuin siirryt seuraavaan parannukseen.

Tip

Kun muokkaat ehdotuksia, säilytä hyvin toimivat osat ja kerro tarkasti, mitä on muutettava. Tämä auttaa Copilot ymmärtämään mieltymyksiäsi ja antamaan parempia tulevaisuuden ehdotuksia.

Summary

Tehokkaiden kehotteiden luominen GitHub Copilot -ohjelmalle on olennaista sen potentiaalin maksimoimiseksi vibe-koodauksessa. Aloittamalla yleisistä kuvauksista, antamalla konkreettisia esimerkkejä, purkamalla monimutkaisia tehtäviä ja ylläpitämällä selkeää viestintää voit ohjata Copilot tuottamaan korkealaatuista koodia, joka vastaa tarpeitasi. Kehotteiden iterointi ja ehdotusten arvioinnin ymmärtäminen parantaa kehityskokemustasi entisestään, jolloin voit hyödyntää tekoälyapua tehokkaasti säilyttäen samalla koodausprosessin hallinnan.

Palaute

Onko tästä sivusta apua?