Кому нужен этот промт и как он работает?
Этот промт предназначен для разработчиков, тимлидов, технических писателей и специалистов по контролю качества программного обеспечения. Он помогает автоматизировать экспертный анализ кода, оценивая архитектуру, дизайн, читаемость и безопасность. Такой подход решает задачи ускорения ревью, поиска ошибок и улучшения качества проекта.
Промт позволяет получить систематический обзор кода с проверкой на соответствие стандартам кодирования, включая Google Python style guide, а также оценивает производительность и покрытие тестами. Для этого нейросеть анализирует предоставленный исходный код или описание функции и формирует рекомендации для оптимизации и повышения качества компонента.
Готовый промт
|
1 |
Выполните экспертный обзор кода для проекта или функции. Проверьте архитектуру, дизайн, соответствие стандартам кодирования, включая Google Python style guide. Оцените структуру кода, читаемость, производительность, безопасность, функциональность и покрытие тестами. Предоставьте подробные рекомендации и примеры улучшений с акцентом на оптимизацию и качество компонента. |
Как использовать промт и на что обратить внимание
Чтобы получить максимально полезный ответ, следуйте рекомендациям:
- Предоставляйте нейросети полный и корректный код или подробно опишите функцию, чтобы обзор был точным.
- Уточняйте, если хотите проверить специфические аспекты, например, безопасность или тестовое покрытие.
- Имейте в виду, что оценка нейросети не заменяет полноценный код-ревью человеком, особенно для сложных или критичных проектов.
- Результаты могут варьироваться в зависимости от объема и качества предоставленного материала.
- Для разных языков программирования и стайл-гайдов необходимо адаптировать промт.
Примеры использования
Первый пример — экспресс-рецензия кода новой функции, чтобы выявить ошибки и улучшить структуру перед слиянием с основной веткой.
|
1 |
Выполните экспертный обзор кода функции, которая реализует обработку данных пользователя в Python. Оцените архитектуру, дизайн и соответствие Google Python style guide. Проверьте читаемость, производительность, безопасность и покрытие тестами. Предоставьте подробные рекомендации и примеры улучшений с акцентом на оптимизацию и качество компонента. |
Второй пример — обзор архитектуры небольшого модуля для обеспечения соответствия код-стандартам и тестовому покрытию в рамках командного проекта.
|
1 |
Выполните экспертный обзор кода модуля проекта, ответственного за взаимодействие с базой данных на Python. Оцените архитектуру, дизайн, соответствие Google Python style guide. Проверьте производительность, безопасность и покрытие тестами. Предоставьте рекомендации и примеры улучшений с акцентом на качество и оптимизацию. |
Пример ответа нейросети на данный промт
Проведен детальный анализ предоставленного кода функции обработки данных пользователей. Архитектура построена на модульном принципе, что положительно сказывается на масштабируемости проекта. Код в основном соответствует Google Python style guide, однако замечена неконсистентность с отступами в некоторых местах и использование слишком длинных функций, что снижает читаемость.
Производительность функции адекватна, но можно оптимизировать циклы и уменьшить количество вызовов к базе данных. В части безопасности рекомендовано добавить проверку ввода для предотвращения SQL-инъекций. Тестовое покрытие частичное, рекомендуется расширить набор юнит-тестов для критичных блоков.
Рекомендации: разбить большие функции на меньшие, использовать встроенные функции Python для ускорения обработки, добавить проверки данных, увеличить охват автоматизированным тестированием. Пример улучшения:def validate_user_input(data):
# Добавить проверки для безопасного ввода
pass
Примечание: результат приблизительный и может отличаться.
Итоги: зачем использовать этот промт?
Использование этого промта позволяет быстро получить экспертное мнение о качестве и безопасности кода с учетом общепринятых стандартов. Это экономит время на обзор и повышает надежность программных компонентов за счет четких рекомендаций по улучшению.
Главное преимущество: автоматизация комплексного и структурированного код-ревью с фокусом на качество и оптимизацию.
