Přehodnoťte funkce "vysvětlit" a "dokument" GitHub Copilot.

  • 5 min

GitHub Copilot usnadňuje vývojářům práci se složitým nebo neznámým kódem. V Visual Studio Code mají vývojáři přímý přístup k funkcím GitHub Copilot, které analyzují, vysvětlují nebo dokumentují kód.

Analýza a vysvětlení kódu pomocí GitHub Copilot

K analýze a vysvětlení kódu je možné použít následující GitHub Copilot funkce:

  • Ptejte se: Pomocí zobrazení chatu v režimu kladení můžete analyzovat celý pracovní prostor a klást otázky týkající se témat kódování, technologických konceptů a obecných programovacích postupů.

  • Vložený chat: Spusťte přímo z editoru relaci chatu a zeptejte se na konkrétní části kódu.

  • Inteligentní akce: Spusťte inteligentní akci Vysvětlit a vysvětlete vybraný kód, aniž byste museli psát výzvu.

  • Rychlý chat: Položte rychlou otázku a vraťte se k tomu, co děláte.

Vytvoření dokumentace ke kódu pomocí GitHub Copilotu

K vygenerování vložené dokumentace kódu je možné použít následující funkce GitHub Copilot:

  • Režim dotazování: Pomocí režimu Zeptejte se agenta navrhněte vloženou dokumentaci kódu pro soubor kódu, třídu nebo metodu. Projděte si navrženou vloženou dokumentaci v zobrazení chatu. Podle potřeby v chatovací konverzaci požádejte o aktualizace. Jakmile budete s navrženou dokumentací spokojeni, můžete do odpovídajícího souboru kódu vložit navrženou dokumentaci.

  • Režim plánu: Režim plánu použijte k vytvoření podrobného plánu implementace pro úlohy dokumentace. Režim Plán lze použít k analýze základu kódu, identifikaci požadavků na dokumentaci a vytvoření podrobného plánu. Jakmile je plán schválen, můžete ho předat do režimu agenta ke spuštění.

  • Režim agenta: Režim agenta můžete použít k autonomnímu generování dokumentace vloženého kódu pro zadané projekty kódu, soubory, třídy nebo metody. Požádejte agenta, aby během procesu dokumentace nebo po jeho dokončení prováděl jiné úlohy. Přijměte nebo odmítněte aktualizace, jakmile agent dokončí přiřazené úkoly.

  • Pomocí chatu ve vloženém režimu můžete pracovat přímo v editoru kódu. Vložený chat je užitečný, když chcete dokumentovat konkrétní kód (třídy, metody nebo bloky kódu) bez opuštění editoru. Můžete zadat konkrétní pokyny do výzvy nebo použít příkaz lomítka /doc bez konkrétních informací, pokud chcete. Aktualizace se zobrazují v editoru kódu a lze je přijmout nebo odmítnout. Můžete také zvolit možnost opětovného spuštění výzvy s aktualizací nebo bez aktualizací.

  • Použijte inteligentní akci Generovat Docs k vytvoření inline dokumentace kódu pro vybranou třídu, metodu nebo blok kódu. Inteligentní akce Generovat dokumentaci je užitečná v případech, kdy nemáte specifické požadavky, které by vyžadovaly výzvu. Aktualizace se zobrazují v editoru kódu a lze je přijmout nebo odmítnout. Můžete také znovu spustit inteligentní akci.

Generování dokumentace k projektu pomocí GitHub Copilot

K vygenerování dokumentace k projektu můžete použít následující funkce GitHub Copilot:

  • Zobrazení chatu v režimu Ptejte se agenta: Pomocí agenta Ask analyzujte základ kódu a získejte přehled o projektech kódu, souborech a třídách. Agent Ask se dá použít k zobrazení náhledu navrhované dokumentace k projektu. Podle potřeby zkontrolujte návrhy a požádejte o aktualizace nebo další podrobnosti. Vložte navrženou dokumentaci do souboru dokumentace projektu (README.md).

  • Zobrazení chatu v režimu plánování agenta: Vytvořte podrobný plán implementace pro dokumentaci k projektu, poté předejte agenta k provedení.

  • Zobrazení chatu v režimu agenta: Vygenerování kolekce souborů dokumentace projektu: vytvoření nebo aktualizace README.md, vytvoření nebo aktualizace UsageExamples.md a vytvoření/aktualizace ChangeLog.md. Zahrňte odkazy mezi soubory dokumentace, křížově odkazujte třídy a metody a zajistěte konzistenci napříč dokumenty.

Důležité

Při použití zobrazení chatu v režimu agenta se každá výzva, kterou zadáte, počítá jako jeden požadavek premium vynásobený násobitelem modelu. GitHub Copilot může k dokončení úkolu provést několik následných akcí, ale tyto následné akce se nezapočítávají do využití požadavků na premium. Fakturují se pouze příkazy, které zadáte. Celkový počet použitých požadavků na premium závisí na počtu výzev, které zadáte, a vybraném modelu. Bezplatný plán pro GitHub Copilot má k dispozici 50 prémiových požadavků za měsíc. Další podrobnosti o limitech požadavků premium pro každé předplatné GitHub Copilot najdete v popisu plánu.

Shrnutí

GitHub Copilot vám pomůže rychle a přesně analyzovat a zdokumentovat kód. Funkce zobrazení chatu, vloženého chatu, rychlého chatu a inteligentních akcí poskytují různé úrovně interakce přímo v prostředí Visual Studio Code.