Оптимизация промптов для документирования кода
Вы работаете в банке уже долгое время и несколько лет поддерживаете большую кодовую базу на Python. Теперь к команде присоединяется новый стажёр, и вы понимаете, что всё накопленное знание хранится только в вашей голове. Вы решаете воспользоваться ИИ-ассистентом, чтобы начать документировать кодовую базу.
Чтобы проверить, насколько этот подход жизнеспособен, вы начинаете с одной функции, сохранённой в файле interest.py, который языковая модель может прочитать и использовать:
def calculate_interest(balance, rate, years):
return balance * (1 + rate) ** years
Это упражнение является частью курса
Разработка с помощью ИИ: курс для разработчиков
Инструкции к упражнению
- Попросите модель **добавить строки документации (docstrings)** к функции, **укажите стандарт** (например, Google style docstrings) и **задайте обязательные разделы**: назначение функции, аргументы (названия и типы), возвращаемый тип и, при необходимости, примеры использования.
Практическое интерактивное упражнение
Превратите теорию в практику с помощью одного из наших интерактивных упражнений
Начать упражнение