Ознайомтеся з функціями «пояснення» та «документування» GitHub Copilot

  • 5 хв.

GitHub Copilot полегшує розробникам роботу зі складним або незнайомим кодом. У Visual Studio Code розробники мають прямий доступ до GitHub Copilot функцій, які аналізують, пояснюють або документують код.

Аналізуйте та пояснюйте код за допомогою GitHub Copilot

Наступні GitHub Copilot функції можна використовувати для аналізу та пояснення коду:

  • Режим запитань. Використовуйте подання чату в режимі запитань, щоб аналізувати всю робочу область і ставити запитання про теми кодування, технологічні поняття та загальні практики програмування.

  • Вбудований чат. Розпочніть вбудований сеанс чату безпосередньо з редактора, щоб запитати про певні розділи коду.

  • Смарт-дії. Виконайте розумну дію Пояснення, щоб пояснити вибраний код, навіть не напишіть запит.

  • Швидкий чат: поставте стисле запитання та поверніться до того, що ви робите.

Генеруйте документацію з вбудованим кодом за допомогою GitHub Copilot

Наступні GitHub Copilot функції можуть використовуватися для створення документації вбудованого коду:

  • Режим запиту: Використовуйте режим агента запиту, щоб запропонувати вбудовану документацію коду для файлу коду, класу або методу. Перегляньте рекомендовану вбудовану документацію в поданні чату. Запитувати оновлення за потреби в розмові чату. Вибравши запропоновану документацію, можна вставити запропоновану документацію до відповідного файлу коду.

  • Режим планування: Використовуйте режим планування, щоб створити детальний план впровадження ваших завдань з документації. Режим плану можна використовувати для аналізу кодової бази, визначення вимог до документації та створення покрокового плану. Після затвердження плану ви можете передати його в режим агента для виконання.

  • Режим агента: Використовуйте режим агента для автономної генерації вбудованої документації коду для визначених проєктів коду, файлів, класів або методів. Попросіть агента виконати інші завдання під час або після процесу документації. Прийміть або відхиліть оновлення, коли агент виконав призначені завдання.

  • Вбудований чат – використовуйте вбудований сеанс чату, щоб працювати безпосередньо в редакторі коду. Вбудований чат зручно використовувати, якщо потрібно документувати певний код (класи, методи або блоки коду), не виходячи з редактора. Ви можете надати конкретні інструкції у запиті або скористатися /doc командою «слеш» без конкретної інформації, якщо хочете. Оновлення відображаються в редакторі коду, їх можна прийняти або відхилити. Також можна вибрати параметр повторного запуску запиту з оновленнями або без цього.

  • Створення смарт-дії Docs. Використовуйте смарт-дію Generate Docs, щоб створити вбудовану документацію коду для вибраного класу, методу або блока коду. Розумна дія Generate Docs корисна, якщо у вас немає певних вимог, для яких потрібен запит. Оновлення відображаються в редакторі коду, їх можна прийняти або відхилити. Ви також можете повторно запустити розумну дію.

Генеруйте документацію проєкту за допомогою GitHub Copilot

Для створення документації проєкту можна використовувати наступні GitHub Copilot функції:

  • Перегляд чату в режимі Ask агента: використовуйте агент Ask для аналізу кодової бази та отримання розуміння проєктів коду, файлів і класів. Агент Ask можна використовувати для попереднього перегляду запропонованої документації проєкту. За потреби перегляньте пропозиції та запитайте оновлення або інші відомості. Вставте запропоновану документацію у файл документації проекту (README.md).

  • Перегляд чату в режимі агента планування: створіть детальний план реалізації для документації проєкту, потім передайте його в режим агента для виконання.

  • Перегляд чату в режимі агента: Генеруйте колекцію файлів документації проєкту: створюйте/оновлюйте README.md, створюйте/оновлюйте UsageExamples.md та створюйте/оновлюйте ChangeLog.md. Додайте зв'язки між файлами документації, класами та методами перехресного посилання та забезпечте узгодженість документів.

Важливо

Коли ви використовуєте перегляд чату в режимі агента, кожен вводний запит рахується як один преміум-запит, помножений на множник моделі. GitHub Copilot може знадобитися кілька наступних дій для виконання завдання, але ці дії не враховуються у використанні вашого преміум-запиту. Виставляються лише ті підказки, які ви вводите. Загальна кількість запитів на премію залежить від кількості запитів, які ви введете, і обраної моделі. Безкоштовний план для GitHub Copilot отримує 50 преміум-запитів на місяць. Ознайомтеся з описом планів для отримання додаткової інформації про ліміти преміум-запитів для кожної підписки GitHub Copilot.

Зведення

GitHub Copilot допомагає швидко та точно аналізувати та документувати ваш код. Режим чату, вбудованого чату, швидкого чату та функцій розумних дій забезпечують різні рівні взаємодії безпосередньо в середовищі Visual Studio Code.