Кому нужен этот промт и как он работает?
Этот промт создан для разработчиков, команд и технических лидеров, которые хотят быстро и качественно проводить проверку кода. Он помогает выявлять потенциальные ошибки, уязвимости безопасности, а также улучшать читаемость и производительность программного обеспечения. Благодаря использованию искусственного интеллекта промт автоматизирует процесс код-ревью, экономя время и повышая качество разработки.
Работает промт просто: пользователь отправляет свои изменения в коде, а «Ассистент код-ревью» анализирует их с помощью статического анализа и методов машинного обучения. Ассистент оценивает качество, выявляет проблемы и предлагает конкретные рекомендации, оформленные по удобной структуре — от заголовка до практических советов. Это делает взаимодействие с отзывами понятным и эффективным.
Готовый к использованию промт
|
1 2 3 4 5 6 7 8 |
Давайте сыграем в интересную игру, где вы выступаете в роли «Ассистента код-ревью». Ваша задача — автоматизировать процесс проверки кода: анализировать изменения, выявлять потенциальные проблемы и предоставлять подробные рекомендации по улучшению. Ассистент оценивает качество кода, соблюдение стандартов и лучших практик, предлагает действия для повышения читаемости, поддерживаемости и производительности. Используйте статический анализ и методы машинного обучения для оценки изменений кода, включая сложность, запахи кода, уязвимости безопасности и узкие места производительности. Генерируйте отчёты с положительными моментами и областями для улучшения, давайте разработчикам подробный, практически применимый фидбек. Структура ответа должна быть: 1. Title: заголовок для предоставленного кода; 2. Assistant Response: детали, что нужно исправить для улучшения, безопасности и т.д.; 3. How: рекомендации и изменения в коде с примерами в формате markdown; 4. Additional Actions: дополнительные рекомендации или варианты дальнейших шагов. Пользователь предоставляет код и получает анализ по данной структуре. Начнем с приветствия и короткого объяснения роли Ассистента код-ревью: «Здравствуйте! Я — Ассистент код-ревью, искусственный интеллект, который поможет вам повысить качество кода. Для начала пришлите изменения в коде или задайте вопросы. Давайте улучшать код вместе!» |
Как использовать промт и на что обратить внимание
Рекомендуется первым делом отправлять изменения или фрагменты кода, чтобы получить максимально точный анализ. Четко формулируйте области, которые вызывают сомнения, если хотите углублённый фидбек.
Пользуйтесь структурой ответа, чтобы легко ориентироваться в полученных рекомендациях. Эта структура помогает не просто обнаружить ошибки, а понять, как и почему их исправлять.
Будьте готовы, что в редких случаях ИИ может не понять контекста сложной бизнес-логики или специфических рамок проекта — тогда стоит дополнительно уточнять детали в вопросах.
Для более глубокого анализа применяйте промт вместе с реальными инструментами статического анализа и тестами, комбинируя автоматические и ручные проверки.
Примеры использования промта
В этом примере разработчик хочет проверить качество нового метода сортировки в своем проекте и ищет рекомендации по оптимизации.
|
1 2 |
Пользователь отправляет код с функцией сортировки, ожидая рекомендаций, например: "Здравствуйте! Я — Ассистент код-ревью. Проанализируй, пожалуйста, этот метод сортировки. Проверь на производительность и читаемость." |
В другом случае инженер безопасности интересуется, нет ли в коде обработчика пользовательских данных уязвимостей SQL-инъекций или XSS.
|
1 2 |
Пользователь присылает функцию обработки данных из формы и спрашивает: "Пожалуйста, проверь на наличие потенциальных уязвимостей в безопасности и дай рекомендации." |
Пример вывода нейросети
Ниже приведён пример того, как Ассистент код-ревью может ответить на запрос с анализом предоставленного кода.
✅ Title: Оптимизация функции сортировки массива и улучшение читаемости кода
Assistant Response: В текущей реализации функции сортировки наблюдается высокая временная сложность из-за использования вложенных циклов. Кроме того, отсутствует обработка граничных случаев, а переменные названы неинформативно. Также не реализованы комментарии, что затрудняет поддержку.
How:
markdownarray
- Замените вложенную сортировку на быструю сортировку для улучшения производительности.
- Переименуйте переменные для повышения читаемости, например, используйтевместоarr.
- Добавьте обработку пустого массива и проверку на null.
- Включите комментарии для ключевых частей кода.Пример улучшения:
python
def quick_sort(array):
if len(array) <= 1: return array pivot = array[len(array) // 2] left = [x for x in array if x < pivot] middle = [x for x in array if x == pivot] right = [x for x in array if x > pivot]
return quick_sort(left) + middle + quick_sort(right)
Additional Actions:
— Используйте профилирование для выявления узких мест.
— Автоматизируйте тесты для проверки функциональности после изменений.
— Подключите инструмент статического анализа для регулярной проверки качества кода.
Итог: почему стоит использовать этот промт?
Данный промт экономит время и силы в процессе код-ревью, помогая быстро выявлять ошибки и давать понятные рекомендации. Он улучшает качество кода и систематизирует обратную связь, что особенно полезно в командах разного размера и уровня экспертизы.
Main benefit: автоматизация и упрощение процесса проверки кода с подробным и понятным фидбеком
