Przeglądaj funkcje „explain” oraz „document” w GitHub Copilot.
GitHub Copilot ułatwia deweloperom pracę ze złożonym lub nieznanym kodem. W Visual Studio Code deweloperzy mają bezpośredni dostęp do funkcji GitHub Copilot, które analizują, wyjaśniają lub dokumentują kod.
Analizowanie i wyjaśnianie kodu przy użyciu GitHub Copilot
Następujące funkcje GitHub Copilot mogą służyć do analizowania i wyjaśniania kodu:
Tryb zadawania pytań: użyj widoku czatu w trybie zadawania pytań, aby przeanalizować cały obszar roboczy i zadać pytania dotyczące tematów kodowania, pojęć technologicznych i ogólnych praktyk programistycznych.
Czat wbudowany: rozpocznij wbudowaną sesję czatu bezpośrednio z poziomu edytora, aby zapytać o konkretne sekcje kodu.
Akcje inteligentne: uruchom akcję inteligentną Wyjaśnij, aby wyjaśnić wybrany kod bez konieczności pisania monitu.
Szybki czat: zadaj szybkie pytanie i wróć do tego, co robisz.
Generowanie dokumentacji kodu wbudowanego przy użyciu GitHub Copilot
Następujące funkcje GitHub Copilot mogą służyć do generowania dokumentacji kodu wbudowanego:
Tryb zapytań: użyj trybu zapytaj agenta, aby zasugerować śródliniową dokumentację kodu dla pliku kodu, klasy lub metody. Przejrzyj sugerowaną dokumentację wbudowaną w widoku czatu. Zażądaj aktualizacji zgodnie z potrzebami w konwersacji na czacie. Po zadowoleniu z proponowanej dokumentacji możesz wstawić sugerowaną dokumentację do odpowiedniego pliku kodu.
Tryb planu: użyj trybu planu, aby utworzyć szczegółowy plan implementacji dla zadań dokumentacji. Tryb planu może służyć do analizowania bazy kodu, identyfikowania wymagań dokumentacji i tworzenia planu krok po kroku. Po zatwierdzeniu planu można przekazać go do trybu agenta do wykonania.
Tryb agenta: użyj trybu agenta, aby autonomicznie wygenerować dokumentację kodu wbudowanego dla określonych projektów kodu, plików, klas lub metod. Agent może wykonywać inne zadania podczas lub po procesie dokumentacji. Zaakceptuj lub odrzuć aktualizacje, gdy agent wykonał przypisane zadania.
Czat wbudowany — użyj wbudowanej sesji czatu, aby pracować bezpośrednio w edytorze kodu. Czat wbudowany jest przydatny, gdy chcesz udokumentować określony kod (klasy, metody lub bloki kodu) bez opuszczania edytora. Możesz podać określone instrukcje w zapytaniu lub użyć polecenia slash
/docbez określonych informacji, jeśli chcesz. Aktualizacje są wyświetlane w edytorze kodu i można je zaakceptować lub odrzucić. Możesz również wybrać opcję ponownego uruchomienia monitu z aktualizacjami lub bez.Użyj inteligentnej akcji Generowanie Dokumentacji, aby tworzyć dokumentację kodu wewnętrznego dla wybranej klasy, metody lub bloku kodu. Akcja inteligentna Generuj dokumenty jest przydatna, gdy nie masz określonych wymagań, które wymagają monitu. Aktualizacje są wyświetlane w edytorze kodu i można je zaakceptować lub odrzucić. Możesz również ponownie uruchomić inteligentną akcję.
Generowanie dokumentacji projektu przy użyciu GitHub Copilot
Następujące funkcje GitHub Copilot mogą służyć do generowania dokumentacji projektu:
Widok czatu w trybie zapytaj agenta: użyj agenta Zapytaj, aby przeanalizować bazę kodu i poznać projekty kodu, pliki i klasy. Agent Ask może służyć do wyświetlania podglądu sugerowanej dokumentacji projektu. Przejrzyj sugestie i zażądaj aktualizacji lub innych szczegółów zgodnie z potrzebami. Wstaw sugerowaną dokumentację do pliku dokumentacji projektu (README.md).
Widok czatu w trybie agenta planu: utwórz szczegółowy plan implementacji dokumentacji projektu, a następnie przekaż go do trybu agenta na potrzeby wykonywania.
Widok czatu w trybie agenta: generowanie kolekcji plików dokumentacji projektu: tworzenie/aktualizowanie README.md, tworzenie/aktualizowanie UsageExamples.md i tworzenie/aktualizowanie ChangeLog.md. Dołącz łącza między plikami dokumentacji, klasami i metodami odwołania krzyżowego oraz zapewnij spójność w dokumentacji.
Ważne
W przypadku korzystania z widoku czatu w trybie agenta każdy monit jest wliczany jako jedno żądanie Premium, pomnożony przez mnożnik modelu. GitHub Copilot może wykonać kilka kroków, aby ukończyć zadanie, ale te kroki nie są wliczane do Twojego zużycia premium. Opłaty są naliczane tylko za polecenia, które wprowadzasz. Łączna liczba użytych żądań premium zależy od liczby monitów wprowadzonych i wybranego modelu. Plan bezpłatny dla GitHub Copilot otrzymuje 50 żądań premium miesięcznie. Zapoznaj się z opisami planów, aby uzyskać więcej informacji na temat limitów żądań premium dla każdej subskrypcji GitHub Copilot.
Podsumowanie
GitHub Copilot ułatwia szybkie i dokładne analizowanie i dokumentowanie kodu. Widok czatu, czat wbudowany, szybki czat oraz funkcje inteligentnych akcji oferują różne poziomy interakcji bezpośrednio w środowisku Visual Studio Code.