Optimera promptar för koddokumentation
Du har arbetat på bankföretaget länge och har underhållit en stor Python-kodbas i flera år. Nu ska en ny praktikant börja, och du inser att all den kunskapen bara finns i ditt huvud. Du bestämmer dig för att använda en AI-assistent för att börja dokumentera kodbasen.
För att testa om det här fungerar i praktiken börjar du med en enda funktion, sparad i interest.py, en fil som LLM:en kan läsa och använda:
def calculate_interest(balance, rate, years):
return balance * (1 + rate) ** years
Den här övningen är en del av kursen
AI-assisterad kodning för utvecklare
Övningsinstruktioner
- Uppmana modellen att **lägga till docstrings** i funktionen, **ange en standard** (t.ex. Google-style docstrings), och **kräv avsnitt** för funktionens syfte, argument (namn/typer), returtyp och eventuellt exempel.
Interaktiv övning med praktiskt arbete
Gör teori till handling med en av våra interaktiva övningar
Starta övningen