Рекомендации по написанию кода
Вы можете настроить Проверка кода Copilot с помощью пользовательских рекомендаций по программированию, написанных на естественном языке. Дополнительные сведения о Проверка кода Copilotсм. в разделе Обзор кода Copilot.
С помощью рекомендаций по написанию кода Copilot могут предоставлять отзывы на основе конкретного стиля написания кода и рекомендаций вашей организации.
Так как Проверка кода Copilot используется большой языковой моделью, она может помочь в применении рекомендаций по программированию, которые не охватываются средством анализа linter или статического анализа.
Рекомендации по написанию кода настраиваются на уровне репозитория. Для каждого репозитория можно создавать и включать до 6 рекомендаций по написанию кода. См . раздел AUTOTITLE.
При запросе проверки из Copilotон автоматически будет использовать рекомендации по написанию кода с поддержкой репозитория для просмотра кода.
Примечания, созданные на основе руководства по написанию кода, будут содержать сообщение, подчеркивающее их источник.
Примечание.
Рекомендации по написанию кода применяются только к проверкам кода, выполняемым Copilot. Рекомендации не влияют на предложения по завершению кода Copilot или код, предлагаемый в ответах Copilot Chat.
Dos и не подходит для рекомендаций по написанию кода
- Используйте простой, понятный и краткий язык для описания руководства по программированию.
- Будьте как можно более конкретными о том, что Copilot должен искать - то есть то, что вы делаете или не хотите видеть в коде.
- Ознакомьтесь с рекомендациями по написанию кода ниже для некоторых вдохновений.
- **** Не пытайтесь использовать рекомендации по программированию для применения рекомендаций по стилю, которые могут быть рассмотрены средством анализа linter или статического анализа.
- **** Не используйте формулировку, которая неоднозначна или может быть интерпретирована разными способами.
- Не пытайтесь соответствовать нескольким различным идеям в одном руководстве по программированию.
Примеры рекомендаций по написанию кода
Пример 1. Избегайте использования магических чисел
Титул: Avoid using magic numbers
Description (Описание): Don't use magic numbers in code. Numbers should be defined as constants or variables with meaningful names.
Шаблоны пути: **/*.py
Пример 2. Не используйте SELECT * в запросах SQL
Титул: Don't use `SELECT *` in SQL queries
Description (Описание): Don't use `SELECT *` in SQL queries. Always specify the columns you want to select. `COUNT(*)` is allowed.
Шаблоны пути: нет (применяется ко всем типам файлов, так как запросы SQL могут быть внедрены в код).
Пример 3. Использование fetch для HTTP-запросов
Титул: Use `fetch` for HTTP requests
Description (Описание): Use `fetch` for HTTP requests, not `axios` or `superagent` or other libraries.
Шаблоны пути: **/*.ts, **/*.js, **/*.jsx``**/*.tsx
Пример 4. Метрики тегов с текущей средой
Титул: Always tag metrics with the current environment
Description (Описание): Always include a `env` tag with the current environment when emitting metrics, for example, `env:prod` or `env:dev`.
Шаблоны пути: */*.go, */*.java