Tutustu GitHub Copilot:n "selitys"- ja "dokumentointi"-ominaisuuksiin

  • 5 minuuttia

GitHub Copilot helpottaa kehittäjien työskentelyä monimutkaisen tai tuntemattoman koodin kanssa. Visual Studio Code kehittäjillä on suora pääsy GitHub Copilot ominaisuuksiin, jotka analysoivat, selittävät tai dokumentoivat koodia.

Analysoi ja selitä koodia käyttäen GitHub Copilot

Seuraavia GitHub Copilot ominaisuuksia voidaan käyttää koodin analysointiin ja selittämiseen:

  • Kysy tila: Analysoi koko työtilasi keskustelunäkymässä ja esitä kysymyksiä koodauksen aiheista, teknologiakäsitteistä ja yleisistä ohjelmointikäytännöistä.

  • Sisäinen keskustelu: Aloita sisäinen keskusteluistunto suoraan editorista ja kysy lisätietoja tietyistä koodiosioista.

  • Älykkäät toiminnot: Suorita Selitä älykäs toiminto, jos haluat selittää valitun koodin kirjoittamatta edes kehotetta.

  • Pikakeskustelu: Esitä nopea kysymys ja palaa takaisin siihen, mitä olet tekemässä.

Luo inline-koodidokumentaatiota käyttämällä GitHub Copilot

Seuraavia GitHub Copilot ominaisuuksia voidaan käyttää inline-koodidokumentaation tuottamiseen:

  • Kysy-tila: Käytä Kysy-agentti-tilaa ehdottaaksesi kooditiedoston, luokan tai metodin sisäistä koodidokumentaatiota. Tarkista ehdotetut sisäiset ohjeet keskustelunäkymässä. Pyydä päivityksiä keskustelukeskustelun tarpeiden mukaan. Kun olet tyytyväinen ehdotettuun dokumentaatioon, voit lisätä ehdotetun dokumentaation vastaavaan kooditiedostoon.

  • Suunnitelmatila: Käytä Suunnitelma-tilaa laatiaksesi yksityiskohtaisen toteutussuunnitelman dokumentaatiotehtävillesi. Suunnitelmatilaa voidaan käyttää koodipohjan analysointiin, dokumentaatiovaatimusten tunnistamiseen ja vaiheittaisen suunnitelman laatimiseen. Kun suunnitelma on hyväksytty, voit siirtää sen Agent-tilaan toteutettavaksi.

  • Agenttitila: Käytä Agentti-tilaa itsenäisesti luodaksesi inline-koodidokumentaatiota määritellyille koodiprojekteille, tiedostoille, luokille tai metodeille. Edustajien tulee suorittaa muita tehtäviä dokumentaatioprosessin aikana tai sen jälkeen. Hyväksy tai hylkää päivitykset, kun agentti on suorittanut määritetyt tehtävät.

  • Sisäinen keskustelu – käytä sisäistä keskusteluistuntoa, kun haluat työskennellä suoraan koodieditorissa. Sisäinen keskustelu on hyödyllinen, kun haluat dokumentoida tietyn koodin (luokat, menetelmät tai koodilohkot) poistumatta editorista. Voit antaa tarkat ohjeet kehotteessa tai käyttää /doc viiltokomentoa ilman tarkkoja tietoja, jos haluat. Päivitykset näkyvät koodieditorissa, ja ne voidaan hyväksyä tai hylätä. Voit myös valita, haluatko suorittaa kehotteen uudelleen päivityksillä tai ilman niitä.

  • Luo Docsin älykäs toiminto: Luo Docs -älykäs toiminto -toiminnolla voit luoda sisäiset koodidokumentaatiot valitulle luokalle, menetelmälle tai koodilohkolle. Docsin luomisen älykäs toiminto on hyödyllinen, kun sinulla ei ole tiettyjä vaatimuksia, jotka edellyttäisivät kehotetta. Päivitykset näkyvät koodieditorissa, ja ne voidaan hyväksyä tai hylätä. Voit myös suorittaa älykkään toiminnon uudelleen.

Luo projektidokumentaatiota käyttämällä GitHub Copilot

Seuraavia GitHub Copilot ominaisuuksia voidaan käyttää projektidokumentaation tuottamiseen:

  • Chat-näkymä Kysy-agenttitilassa: Käytä Kysy-agenttia analysoidaksesi koodipohjaa ja saadaksesi ymmärryksen koodiprojekteista, tiedostoista ja luokista. Ask-agenttia voidaan käyttää ehdotettujen projektidokumentaatioiden esikatseluun. Tarkista ehdotukset ja pyydä päivityksiä tai muita tietoja tarpeen mukaan. Lisää ehdotetut ohjeet projektin dokumentaatiotiedostoon (README.md).

  • Chat-näkymä Plan Agent -tilassa: Laadi yksityiskohtainen toteutussuunnitelma projektin dokumentaatiolle ja siirrä se agenttimoodiin toteutusta varten.

  • Chat-näkymä agenttitilassa: Luo kokoelma projektin dokumentaatiotiedostoja: luo/päivitä README.md, luo/päivitä UsageExamples.md ja luo/päivitä ChangeLog.md. Sisällytä linkkejä dokumentaatiotiedostojen, ristiviittausluokkien ja menetelmien välille ja varmista johdonmukaisuus kaikissa asiakirjoissa.

Tärkeää

Kun käytät Chat-näkymää agenttitilassa, jokainen syöttämäsi kehote lasketaan yhdeksi premium-pyynnöksi, kerrottuna mallin kertoimella. GitHub Copilot saatat tehdä useita jatkotoimia tehtäväsi suorittamiseksi, mutta nämä toimenpiteet eivät vaikuta premium-pyyntöjen käyttöön. Vain syöttämäsi kehotteet laskutetaan. Käytettyjen vakuutusmaksupyyntöjen kokonaismäärä riippuu siitä, kuinka monta kehotetta syötät ja minkä mallin valitset. Ilmainen suunnitelma GitHub Copilot saa 50 premium-pyyntöä kuukaudessa. Katso suunnitelman kuvaukset saadaksesi lisätietoja premium-pyyntörajoista jokaiselle GitHub Copilot tilaukselle.

Yhteenveto

GitHub Copilot auttaa sinua analysoimaan ja dokumentoimaan koodisi nopeasti ja tarkasti. Chat-näkymä, inline-chat, pikachat ja älykkäiden toimintojen ominaisuudet tarjoavat erilaisia vuorovaikutustasoja suoraan Visual Studio Code -ympäristössä.