Кому нужен этот промт и как он работает?
Этот промт предназначен для программистов, инженеров и тех, кто работает с исходным кодом и хочет быстро добавить понятные комментарии к сложным участкам. Он помогает улучшить читаемость кода, облегчает его поддержку и ускоряет понимание логики, особенно когда код содержит нестандартные решения или сложные функции.
Промт работает так: вы отправляете нейросети фрагменты кода, и она автоматически вставляет комментарии в нужных местах, руководствуясь чёткими правилами. Это экономит время на написание пояснений вручную и помогает избегать избыточных или бесполезных комментариев.
Готовый к использованию промт
|
1 |
Представь, что ты инженер-программист. Я буду присылать тебе куски кода. Твоя задача — добавлять комментарии в подходящих местах согласно следующим правилам: 1) комментарии не должны повторять код, 2) хорошие комментарии не оправдывают непонятный код, 3) если не можешь написать понятный комментарий, обозначь это как [Предупреждение], 4) комментируй только функции или сложную логику, 5) объясняй нестандартный код, 6) используйте комментарии для обозначения незавершённых частей, 7) не комментируй понятный код. Теперь попроси меня прислать код. |
Как использовать промт и на что обратить внимание
- Отправляйте нейросети небольшие и логически завершённые куски кода — так комментарии будут более точными и полезными.
- Проверяйте комментарии на предмет точности и полноты, некоторая логика может требовать доработки вручную.
- Учитывайте, что промт комментирует только сложные или нестандартные участки, поэтому понятные строки останутся без изменений.
- Если нейросеть не может понять часть кода, она вставит метку
[Предупреждение]— это сигнал вам обратить на этот участок внимание лично. - Промт хорошо подходит для разных языков программирования, но в случае сильно необычного синтаксиса может потребоваться адаптация.
Примеры использования
Первый пример решает задачу быстрого документирования функций с комплексной логикой, позволяя программисту лучше ориентироваться в большом коде.
|
1 |
Представь, что ты инженер-программист. Я буду присылать тебе куски кода на Python. Твоя задача — добавлять комментарии в подходящих местах согласно правилам из основного промта. Теперь попроси меня прислать код. |
Второй пример подходит для случаев, когда нужно комментировать участки с нестандартными алгоритмами на языке JavaScript, чтобы облегчить командную работу.
|
1 |
Представь, что ты инженер-программист. Я буду присылать тебе куски кода на JavaScript. Твоя задача — добавлять комментарии в подходящих местах согласно правилам из основного промта. Теперь попроси меня прислать код. |
Пример результата работы нейросети по этому промту
Ниже приведён пример комментариев, которые нейросеть вставила в функцию на Python с учётом данных правил.
def calculate_discount(price, discount):
# Вычисляет итоговую цену с учётом скидки
if discount < 0 or discount > 100:
# [Предупреждение] Некорректное значение скидки
return price
discounted_price = price * (1 — discount / 100)
return discounted_price
Примечание: результат приблизительный и может отличаться в зависимости от переданного кода.
Итог: зачем использовать этот промт?
Этот промт существенно ускоряет и упрощает процесс комментирования сложного или нестандартного кода, помогает поддерживать читабельность и качество программных проектов. Он особенно полезен при работе с большими кодовыми базами и командной разработке.
Главное преимущество: быстрое, чёткое и полезное комментирование сложных участков кода без избыточных пояснений.
