Ознакомьтесь с функциями GitHub Copilot для "объяснения" и "документирования"
GitHub Copilot упрощает работу разработчиков с сложным или незнакомым кодом. В Visual Studio Code разработчики имеют прямой доступ к функциям GitHub Copilot, которые анализируют, объясняют или документируют код.
Анализ и объяснение кода с помощью GitHub Copilot
Для анализа и объяснения кода можно использовать следующие GitHub Copilot функции:
Режим вопросов: используйте представление чата в режиме запросов, чтобы проанализировать всю рабочую область и задать вопросы о темах программирования, концепциях технологий и общих методиках программирования.
Встроенный чат: запустите встроенный сеанс чата непосредственно из редактора, чтобы узнать о конкретных разделах кода.
Интеллектуальные действия. Запустите интеллектуальное действие "Объяснить", чтобы объяснить выбранный код, даже не записывая запрос.
Быстрый чат: задайте быстрый вопрос и вернитесь к тому, что вы делаете.
Генерировать документацию для встроенного кода с помощью GitHub Copilot
Следующие GitHub Copilot функции можно использовать для создания встроенной документации по коду:
Режим ask: используйте режим агента Ask, чтобы предложить встроенную документацию по коду для файла кода, класса или метода. Просмотрите рекомендуемую встроенную документацию в окне чата. Запрашивайте обновления по мере необходимости в чате. Как только вы будете довольны предлагаемой документацией, её можно вставить в соответствующий файл кода.
Режим плана: используйте режим плана для создания подробного плана реализации для задач документации. Режим плана можно использовать для анализа базы кода, определения требований к документации и создания пошагового плана. После утверждения плана его можно передать в режим агента для выполнения.
Режим агента: используйте режим агента для автономного создания встроенной документации по коду для указанных проектов кода, файлов, классов или методов. Агент выполняет другие задачи во время или после процесса документации. Примите или отклоните обновления, когда агент выполнил назначенные задачи.
Встроенный чат — используйте встроенный сеанс чата для работы непосредственно в редакторе кода. Встроенный чат полезен, если вы хотите документировать определенный код (классы, методы или блоки кода) без выхода из редактора. При необходимости можно указать конкретные инструкции в подсказке или использовать команду с косой чертой
/doc, если не требуется конкретная информация. Обновления отображаются в редакторе кода и могут быть приняты или отклонены. Вы также можете выбрать вариант повторного запуска запроса с обновлениями или без них.Смарт-действие 'Генерация Документов': используйте смарт-действие 'Генерация Документов' для создания встроенной документации на код для выбранного класса, метода или блока кода. Смарт-действие "Создать документы" полезно, если у вас нет конкретных требований, требующих запроса. Обновления отображаются в редакторе кода и могут быть приняты или отклонены. Вы также можете повторно запустить интеллектуальное действие.
Создание документации по проекту с помощью 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.