Кому нужен этот промт и как он работает?
Этот промт предназначен для разработчиков, тимлидов, технических ревьюеров и всех, кто хочет провести глубокий анализ кода. Он помогает выявить проблемы читаемости, производительности и поддержки кода, а также проверить соответствие лучшим практикам программирования. Использование промта упрощает процесс ревью, делая его структурированным, конструктивным и понятным.
Промт работает как помощник по ревью кода: нейросеть детально анализирует структуру, стиль и эффективность представленного кода. Она проверяет имена переменных и функций, форматирование, архитектурные шаблоны, производительность, а также наличие документации и тестов. На основе этого выдает рекомендации и примеры для повышения качества кода, что ускоряет процесс исправлений и улучшений.
Готовый к использованию промт
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 |
Выступайте в роли помощника по ревью кода. Ваша задача — предоставить конструктивную обратную связь и рекомендации по качеству предоставленного кода. Оценивайте читаемость, поддерживаемость, эффективность, соответствие лучшим практикам и общие шаблоны проектирования. 1. Тщательно изучите код, включая отдельные файлы и модули. Проанализируйте ясность имен переменных и функций, правильность отступов и единообразие стиля кодирования. Проверьте структуру кода на соответствие принципам модульности и разделения ответственности. 2. Оцените эффективность и производительность кода. Ищите возможные узкие места, излишние вычисления или неэффективные алгоритмы. Предложите оптимизации для улучшения скорости и использования ресурсов. 3. Проверьте соблюдение отраслевых стандартов: использование систем контроля версий, наличие документации и модульных тестов. Обнаружьте потенциальные уязвимости и риски. 4. Оцените поддерживаемость, анализируя организацию кода, его читаемость и применение шаблонов проектирования. Выявите дублирование, излишнюю сложность или нарушения ООП. Рекомендуйте рефакторинг и архитектурные улучшения. 5. Предоставляйте конкретные примеры и объяснения для каждого аспекта с обоснованием ваших предложений. Хвалите сильные стороны. 6. В завершение подведите общий итог и присвойте оценку, указав основные моменты, положительные и требующие улучшения. Подходите к ревью конструктивно и с целью помочь разработчику повысить качество кода. Когда будете готовы, запросите у пользователя код для анализа. |
Как использовать промт и на что обратить внимание
Чтобы получить максимальную пользу, передайте в чат или нейросети актуальный код целиком или по частям. Чем полнее и яснее код, тем точнее рекомендации.
Рекомендуется выделять отдельные участки кода или модули для поэтапного анализа, если проект большой. Это поможет избежать упрощённых выводов.
Обращайте внимание на рекомендации по оптимизации и рефакторингу. Иногда стоит обсудить с командой предлагаемые изменения.
Возможны случаи, когда нейросеть может упустить специфические бизнес-логики или особые условия проекта. В таких ситуациях дополнительно проконсультируйтесь с профильным специалистом.
Не рассчитывайте на автоматическую замену профессионального ревьюера — промт дополнит и ускорит процесс, но не заменит экспертных знаний.
Примеры применения
Пример 1. Ревью кода нового модуля библиотеки
Задача: быстро проверить код нового модуля на читаемость и архитектуру перед интеграцией в проект.
|
1 |
Выступайте в роли помощника по ревью кода. Ваша задача — предоставить конструктивную обратную связь и рекомендации по качеству предоставленного кода модуля платежей. Оценивайте читаемость, поддерживаемость, эффективность, соответствие лучшим практикам и общие шаблоны проектирования. Проверьте ясность имен переменных, правильность отступов, структуру по модульности, производительность, тесты и документацию. Предоставьте конкретные примеры и советы с объяснениями, а также подведите итоги с оценкой. |
Пример 2. Анализ скрипта для парсинга данных
Задача: оптимизировать скрипт, чтобы он работал быстрее и был проще в поддержке.
|
1 |
Выступайте в роли помощника по ревью кода. Ваша задача — дать конструктивную обратную связь и рекомендации по улучшению качества скрипта для парсинга сайта. Оцените код на читаемость, эффективность, соответствие лучшим практикам, проверьте наличие дублирования и уязвимостей. Предложите оптимизации и примеры рефакторинга, закончите обзор итогами и оценкой. |
Пример вывода нейросети по данному промту
После анализа кода модуля была отмечена хорошая читаемость и логичное распределение функций. Имена переменных четко отражают их предназначение, отступы и стиль соответствует PEP8. Выявлено дублирование функций parseData и extractData, рекомендуется объединить их для улучшения поддержки. Также обнаружен избыточный цикл по массиву данных, что замедляет работу — предложена замена на более эффективный алгоритм через map() и filter(). Недостаточно покрыта документация к основным классам, что усложнит работу новым разработчикам. Модульные тесты отсутствуют, советуем добавить их для повышения надежности. В целом код заслуживает оценки 7.5 из 10 с перспективой улучшения при выполнении рекомендаций.
Note: результат примерный и может отличаться.
Итог: зачем использовать этот промт?
Использование этого промта значительно упрощает и ускоряет процесс ревью кода. Он структурирует анализ по ключевым аспектам: читаемость, производительность, поддерживаемость и безопасность. Благодаря конкретным примерам и рекомендациям разработчики получают понятный план улучшений. Это экономит время команды и повышает качество продукта.
Главное преимущество: быстрый и конструктивный анализ кода с подробными рекомендациями для улучшения качества и поддержки
