Рекомендуется использовать linter, чтобы проверить код на наличие потенциальных ошибок, нарушений стиля или отклонений от рекомендаций. Linters может помочь вам ловить ошибки раньше, улучшить удобочитаемость кода и обеспечить согласованность и обслуживание кода.
Пример сценария
Вы выполнили в коде литер и определили некоторые проблемы, которые необходимо исправить. Вместо того чтобы исправлять их вручную, вы можете попросить Копилот Чат их починить за себя.
Примеры подсказок
-
Выберите весь код в редакторе, а затем введите:
Copilot prompt Fix the lint errors
Fix the lint errors -
Можно указать определенный набор рекомендаций по написанию кода для языка, например PEP8 для Python:
Copilot prompt Use PEP8 to fix the lint errors
Use PEP8 to fix the lint errors -
Если у вас есть локальный файл, определяющий соглашения и правила кодирования, можно перетащить файл в окно чата, чтобы добавить его в виде вложения, а затем введите:
Copilot prompt Use the attached style guide to fix the lint errors
Use the attached style guide to fix the lint errors -
В качестве альтернативы можно попросить Копилот Чат исправить только определённый тип ошибки ворса:
Copilot prompt Make sure all functions use snake_case naming style
Make sure all functions use snake_case naming style
Пример ответа
Copilot говорит, что нужно изменить, а затем даёт исправленный код. Перед его использованием необходимо тщательно просмотреть предлагаемый код. Код, который Copilot предлагает, может не решить все проблемы, выявленные вашим линтером, поэтому всегда стоит запускать линтер заново, если вы решите использовать рекомендованный код.
Проблемы с покрытием, которые Copilot могут помочь вам устранить, включают:
- Добавление необходимых импортов, которые отсутствуют.
- Удаление импортов, которые не используются в коде.
- Разделение инструкций импорта на отдельные строки.
- Использование имен методов и функций, которые соответствуют рекомендациям по стилю.
- Добавление пробелов вокруг операторов.
- Обеспечение согласованного отступа.
- Удаление конечных пробелов.
- Разделение нескольких операторов, которые находятся в одной строке, на отдельные строки.
- Разрыв длинной линии на несколько строк.
- Удаление неиспользуемых переменных.
- Добавление или удаление пустых строк для соблюдения рекомендаций по стилю.
- Добавление документов в функции, классы и модули.
- Удаление кода, который никогда не будет выполняться.
- Убедитесь, что все операторы возврата в функции возвращают значение или нет.
- Сокращение или устранение использования глобальных переменных.
- Обеспечение вызова функций с правильным числом и типом аргументов.
- Обеспечение правильности размещения примечаний и их смысл.
- Замена инструкций печати правильным ведением журнала.