AI WORLD HQÍrj érthető kommenteket a kódodhoz a GitHub Copilottal – kezdőknek
Barátságos, lépésről lépésre haladó útmutató, amely megmutatja, hogyan kérheted meg a GitHub Copilotot, hogy közérthető megjegyzéseket fűzzön a kódsorokhoz
Bevezető: Az útmutató végére már bármelyik kódsor fölé tudsz majd érthető megjegyzést íratni a GitHub Copilottal – még akkor is, ha soha nem nyitottál meg kódszerkesztőt. Ez a leírás abszolút kezdőknek szól, akik a saját scriptjeiket és mások számára is érthetőbbé szeretnék tenni.
💡 Tipp: kattints egy lépés számára, ha kész vagy — zöld pipa jelenik meg, és a böngésződ megjegyzi, meddig jutottál.
Mielőtt belevágsz
- Egy ingyenes GitHub-fiók (ezzel jelentkezel majd be a VS Code-ba).
- Telepített Visual Studio Code a gépeden (Windows, macOS vagy Linux).
- Aktív GitHub Copilot-előfizetés – a 30 napos ingyenes próba is jó, utána fizetős csomag kell.
- Egy egyszerű kód- vagy szövegfájl, amin nyugodtan kísérletezhetsz.
- Körülbelül 10 perc nyugalom.
A Visual Studio Code letöltése és telepítése
Nyisd meg a code.visualstudio.com oldalt bármilyen böngészőben; középen egy nagy gombot fogsz látni, amely általában „Download for Windows”, „Download for macOS” vagy „Download for Linux” feliratú. Kattints erre a gombra, majd nyisd meg a telepítőt a Letöltések mappából (a fájlnév .exe, .dmg, .deb vagy .rpm végződésű). A telepítő végigvezet néhány képernyőn – kattints a „Next” gombra, fogadd el a licencet, majd nyomd meg az „Install” gombot. Amikor a telepítés befejeződik, a VS Code elindul: egy ablakot látsz, baloldalt egy vékony sávval, középen pedig egy üres szerkesztőfelülettel. Ha a gomb felirata nem pont ez, keresd az „Other platforms” vagy a „Get VS Code for…” linket. Akkor jártál sikerrel, ha megjelenik a VS Code ikonja az asztalon vagy az alkalmazások között, és a program megnyit egy üres szerkesztőt.
Jelentkezz be a GitHubba a VS Code-ból
A VS Code megnyitása után pillants az ablak bal alsó sarkára; egy kis sziluett-ikont fogsz látni – ez az Accounts (Fiókok) gomb (gondolhatsz rá úgy, mint egy ajtóra, amelyen keresztül a VS Code megismeri a személyazonosságodat). Kattints rá; egy kis panel csúszik fel, amelyen a „Sign in with GitHub” opciót találod. Válaszd ezt; megnyílik az alapértelmezett böngésződ, és felkér a bejelentkezés jóváhagyására. Miután rákattintottál a jóváhagyásra, a panel eltűnik, és a sziluett helyén egy kis avatar vagy a monogramod jelenik meg. Ha nem látod a sziluettet, nyisd meg a menüsort, válaszd a View → Command Palette opciót, írd be, hogy „Sign in”, és válaszd a GitHubot említő lehetőséget. Akkor jártál sikerrel, ha a VS Code bal alsó sarkában megjelenik a GitHub-felhasználóneved vagy az avatarod.
A GitHub Copilot bővítmény telepítése
A bal oldali sávon keresd azt az ikont, amely négy négyzetre hasonlít, rácsba rendezve – ez nyitja meg az Extensions nézetet (képzelj el egy mini alkalmazásboltot a VS Code-on belül). Kattints az ikonra; megjelenik egy panel, felül egy keresősávval. Írd be a keresőbe, hogy GitHub Copilot. Az első találat a hivatalos Copilot bővítmény, mellette egy Install gombbal. Kattints az Install gombra; a VS Code letölti a bővítményt, és automatikusan engedélyezi is. Ha a folyamat befejeződött, egy új Copilot-ikon (általában egy stilizált csevegőbuborék) jelenik meg a tevékenységsávon – ez a bal szélén lévő vékony függőleges sáv. Ha nem találod a négyzet-ikont, a felső menüből a View → Extensions opciót is használhatod. Akkor jártál sikerrel, ha a bővítmények listájában a GitHub Copilot „Enabled” (engedélyezett) állapotú, és a Copilot ikon megjelenik a tevékenységsávon.
Nyiss meg egy kódfájlt a szerkesztőben
Kattints a bal oldali sáv első ikonjára – két egymásra helyezett lapra hasonlít, és az Explorer (Fájlkezelő) nézetet jelenti (úgy is gondolhatsz rá, mint egy mappaböngészőre). Az Explorer panelen navigálj el abba a mappába, amelyben van egy fájl, például example.js vagy notes.txt. Egy kattintással jelöld ki a fájlt, majd dupla kattintással nyisd meg; a fájl tartalma megjelenik a középső szerkesztőfelületen, bal oldalon pedig egy sornumsor. (Egy függvény nem más, mint egy elnevezett utasításcsomag, olyan, mint egy receptkártya, a komment pedig egy megjegyzés az emberi olvasónak, amelyet a számítógép csendben figyelmen kívül hagy.) Ha az Explorer nem látható, nyomd meg a Ctrl+Shift+E billentyűkombinációt (macOS-en Cmd+Shift+E). Akkor jártál sikerrel, ha a fájl szövege megjelenik a szerkesztőben, és a bal szélén sorszámok futnak lefelé.
Kérd meg a GitHub Copilotot, hogy javasoljon kommentet egy kódsor fölé
Vigye a kurzort közvetlenül a magyarázni kívánt sor feletti üres sorba. Írd be, hogy //, majd utána egy rövid utasítást, például Explain what this line does. Sok esetben a GitHub Copilot halvány, szürke ghost text (szellemszöveg) javaslatot mutat, amint befejezted a gépelést – ez a Copilot soron belüli automatikus kiegészítése. Ha megjelenik a szellemszöveg, nyomd meg a Tab billentyűt, hogy valódi kommentté váljon; ha el szeretnéd dobni és más promptot próbálni, nyomd meg az Escape billentyűt.
Ha nem jelenik meg szellemszöveg, annak oka lehet, hogy túl rövid az utasítás, vagy a bővítménynek van még egy kis töltési ideje. Ilyen esetben használhatod a beépített parancsot is tartalékként: nyisd meg a Parancspalettát (Ctrl+Shift+P / Cmd+Shift+P), és futtasd a „GitHub Copilot: Explain” parancsot. A Copilot ezután az aktuális sor alapján szúr be egy kommentet.
Akkor jártál sikerrel, ha érthető komment jelenik meg a kiválasztott sor felett, amely közérthető nyelven foglalja össze a sor célját.
Nézd át, szerkeszd és mentsd el a javaslatot
Olvasd fel hangosan az újonnan beszúrt kommentet; ha pontosan leírja a kódot, kész is vagy. Ha a megfogalmazás nem tökéletes, egyszerűen kattints a komment sorába, és írd át a szöveget – a Copilot nem tanul ezekből a javításokból, tehát a kézi finomítás teljesen normális. Végül mentsd el a fájlt a Ctrl+S billentyűkombinációval (macOS-en Cmd+S); a fájlnév melletti pont eltűnik, jelezve, hogy a fájl mentve van. Ha a komment még mindig nem elég érthető, menj vissza az 5. lépéshez, és fogalmazd át a promptot (például: Summarise the tax-calculation step in plain English).
- Teljes kódblokkot írsz be rövid utasítás helyett. A GitHub Copilot rövid utasításokkal működik a legjobban, például
// Explain this step. Megoldás: tartsd 10 szó alatt az indítósort. - Az Escape billentyűt nyomod meg, mielőtt elfogadnád a szellemszöveget. A szürke javaslat épp az, amit szeretnél; az Escape eldobja. Megoldás: nyomd meg a Tab billentyűt a javaslat elfogadásához, és csak utána szerkeszd, ha kell.
- Azt várod, hogy a Copilot elsőre megérti a nagyon bonyolult logikát. Hosszabb vagy kétértelmű kódnál a kommentek gyakran pontatlanok lesznek. Megoldás: adj több kontextust a promptodhoz, vagy bontsd kisebb részekre a kódot, és egyszerre csak egy kommentet kérj.
Mit jelent ez számodra?
- A mindennapokban: gyorsan tehetsz érthető megjegyzéseket a bemásolt személyes scriptjeid mellé, így amikor legközelebb megnyitod a fájlt, emlékezni fogsz, mit csinál az adott sor.
- A munkádban vagy vállalkozásodban: a csapatod a Copilottal generált kommenteknek köszönhetően gördülékenyebben adhatja át a projekteket, mert a kód bárki számára könnyen olvashatóvá válik – ehhez nincs szükség külön dokumentációs sprintre.
- Ha most ismerkedsz a kóddal: nyisson meg egy pici fájlt, ami már a tiéd, tedye a kurzort egy új sorba, írd be, hogy
// Explain what this line does, és figyeld, ahogy a GitHub Copilot néhány másodperc alatt barátságos kommentté alakítja.
Próbáld ki most
Nyiss meg egy tetszőleges kód- vagy szövegfájlt, amit már ismersz, helyezd a kurzort egy ismerős sor feletti üres sorba, írd be, hogy // Explain what this line does, nyomd meg a Tab billentyűt, amikor megjelenik a szellemszöveg (vagy használd a „GitHub Copilot: Explain” parancsot, ha nem jelenik meg), majd mentsd el a fájlt. Két percen belül a szerkesztőben lesz az első, Copilottal írt kommented.
❓ Gyors kérdések
Mennyi időt vesz igénybe?
Kb. 6 perc — az útmutató 6 lépésből áll, és mindegyiket ki tudod pipálni, ahogy haladsz.
Milyen eszköz kell hozzá?
Ez az útmutató a(z) GitHub GitHub Copilot eszközt használja — de a módszer nagyon hasonlóan működik más AI-asszisztensekben is.
Milyen hibákat kerüljek el?
- Teljes kódblokkot írsz be rövid utasítás helyett. A GitHub Copilot rövid utasításokkal működik a legjobban, például
// Explain this step. Megoldás: tartsd 10 szó alatt az indítósort. - Az Escape billentyűt nyomod meg, mielőtt elfogadnád a szellemszöveget. A szürke javaslat épp az, amit szeretnél; az Escape eldobja. Megoldás: nyomd meg a Tab billentyűt a javaslat elfogadásához, és csak utána szerkeszd, ha kell.
- Azt várod, hogy a Copilot elsőre megérti a nagyon bonyolult logikát. Hosszabb vagy kétértelmű kódnál a kommentek gyakran pontatlanok lesznek. Megoldás: adj több kontextust a promptodhoz, vagy bontsd kisebb részekre a kódot, és egyszerre csak egy kommentet kérj.
Olvass tovább
📬 A hét AI-hírei, egyenesen a postafiókodba
Hetente egy barátságos email vasárnaponként — az 5 sztori, ami számított, közérthetően. Semmi spam, bármikor leiratkozhatsz.
✦ Az AI World HQ AI-szerkesztőségének eredeti, lépésről lépésre útmutatója. Közérthetően írva, pontosságra ellenőrizve.
← Vissza a hírekhez