Промт для экспертного ревью кода с комментариями по стилю

Кому нужен этот промт и как он работает?

Этот промт создан для программистов, технических лидеров и специалистов по ревью кода, которые хотят быстро получить экспертный анализ качества программного кода. Особенно он полезен для тех, кто работает с git и знаком с правилами оформления кода в определённых языках программирования и фреймворках. Промт помогает выявлять нарушения правил стиля и улучшать читаемость, поддерживаемость и производительность за счёт автоматических комментариев к коду. Благодаря этому можно повысить качество кода, избежать багов и ускорить командную разработку.

Работает промт так: вы передаёте фрагмент кода, ограниченный тройными обратными кавычками. Искусственный интеллект определяет, на каком языке написан код, сверяет его с типичными стандартами оформления (например, PEP8 для Python) и отмечает ошибки или нарушения в виде комментариев прямо внутри кода. При этом он ориентируется на недавно изменённые или добавленные части, чтобы сосредоточиться на актуальных изменениях. Такой подход помогает понять, что именно нужно поправить и почему, с ссылками на конкретные правила стиля.

Готовый промт

Как использовать промт и на что обращать внимание

Используйте этот промт, когда хотите быстро провести ревью новых изменений в коде или оценить качество правок. Вставляйте свежий код в тройные обратные кавычки и указывайте нужные языки и фреймворки в переменных {{Programming Languages}} и {{Framework/Library}}, чтобы повысить точность анализа.

Обратите внимание на следующие рекомендации:

• Всегда чётко задавайте языки программирования и фреймворки, если код смешанный или используется несколько технологий.
• Проверяйте, что вставленный код действительно включает последние изменения — промт сфокусирован именно на них.
• Если результат кажется неполным или неясным, задавайте уточняющие вопросы, чтобы AI мог получить дополнительный контекст.
• Не рассчитывайте на исправление сложных логических ошибок — промт направлен на стиль и читаемость.
• Помните, что некоторые правила стиля могут отличаться в разных командах, поэтому оценивайте рекомендации с учётом ваших внутренних стандартов.

Примеры использования

Первый пример показывает, как использовать промт для ревью кода на Python с фреймворком Django. Это поможет выявить несоблюдение PEP8 и улучшить структуру кода в модельных классах.

Второй пример демонстрирует обработку JavaScript-кода с использованием React. Он поможет улучшить форматирование JSX и работу с хуками, что повысит качество пользовательских компонентов.

Пример вывода нейросети

Ниже приведён пример того, как AI может прокомментировать Python-код с нарушениями стиля:

def get_user(id):
user = User.objects.get(id=id) # Использование односимвольной переменной id без пояснения — нарушение PEP8, пункт Naming Conventions: https://pep8.org/#id-plugins
return user # Рекомендуется добавить обработку исключений для повышения надёжности


Примечание: результат приблизительный и может варьироваться.

Итог: зачем использовать этот промт?

Данный промт существенно экономит время на ревью кода, автоматически выявляя нарушения стиля именно в ваших последних изменениях. Он помогает быстро сделать код более читаемым и удобным для дальнейшей поддержки, а также повышает производительность команды за счёт уменьшения количества исправлений.

Главное преимущество: экспертный разбор кода с комментариями inline, позволяющий легко понять и исправить ошибки стиля