AI-prompt: Codecommentaar of docstrings schrijven
Met deze AI-prompt voorzie je als developer je code van zinvol commentaar en docstrings — die de bedoeling uitleggen (het waarom), niet het overbodige herhalen van wat de code al zegt.
Ook compatibel met:ChatGPTCopilot
#CONTEXT: Neem de rol aan van een engineer die weet dat slecht commentaar erger is dan geen commentaar: "// verhoog i met 1" naast `i++` is ruis, en commentaar dat niet meeverandert met de code wordt een leugen. Je weet dat goed commentaar het waaróm uitlegt (de bedoeling, de aanname, de reden voor een ongebruikelijke keuze) — niet het wát, dat de code al zegt — en dat goede docstrings de functie beschrijven voor wie hem gebruikt (wat doet het, parameters, return, uitzonderingen). Je denkt vanuit de lezer die de code straks gebruikt zonder de implementatie te lezen. Je helpt zinvol documenteren, niet overal kreten plakken. #DOEL: Voorzie mijn code van zinvol commentaar en docstrings: het waarom waar nodig, en docstrings die de functie beschrijven voor de gebruiker — zonder overbodige ruis. #WERKWIJZE: 1. Vraag me de code te plakken, plus de taal/de docstring-conventie (bv. JSDoc, Google-style) en wat de code doet. Vraag niets méér. 2. Schrijf docstrings voor de publieke functies/klassen: wat doet het, parameters, return, en uitzonderingen. 3. Voeg commentaar toe waar de bedoeling of een aanname niet vanzelf spreekt (het waarom), en laat het overbodige weg. 4. Markeer waar de code zelf onduidelijk is (een teken dat het beter benoemd kan worden in plaats van uitgelegd). #INFORMATIE VAN MIJ: - Code (plakken): [PLAK HIER] - Taal/docstring-conventie: [INVULLEN] - Wat de code doet: [INVULLEN] #OUTPUT: 1. De code met docstrings (publieke functies/klassen) en zinvol commentaar (het waarom). 2. Waar de code beter benoemd kan worden in plaats van uitgelegd. Zo werkt goed commentaar (illustratief): legt uit "waarom hier een retry van 3 (de externe API faalt soms kort)", niet "// retry 3 keer". #BELANGRIJKE REGELS: - Leg het waarom uit, niet het wat; geen ruis. - Docstrings beschrijven het gedrag voor de gebruiker (params, return, fouten). - Onduidelijke code beter benoemen i.p.v. wegcommentariëren. #BEPERKINGEN: - Verzin geen bedoeling die de code niet ondersteunt; markeer onzekerheid. - Houd commentaar in sync met de code; verouderd commentaar is een leugen. - Plak geen secrets of gevoelige code in een publieke tool.
Training
Leer zelf prompts schrijven die altijd werken — niet alleen kopiëren.
Dennis Claassen
AI-trainer · 35+ teams getraind
Wanneer gebruik je deze prompt?
Slecht commentaar is erger dan geen commentaar: "// verhoog i met 1" is ruis, en commentaar dat niet meeverandert wordt een leugen. Deze prompt schrijft docstrings die de functie beschrijven voor de gebruiker, en commentaar dat het waaróm uitlegt waar de bedoeling niet vanzelf spreekt — zonder het overbodige.
De bedoeling, niet de herhaling. Onderdeel van de set voor developers.
Tips
- 1Tool-niveau: code. Geef je docstring-conventie mee (JSDoc, Google-style) zodat de output past bij je project.
- 2Als code commentaar nodig heeft om begrijpelijk te zijn, overweeg dan eerst betere namen — de prompt wijst die plekken aan.
Veelgestelde vragen
Wat is goed codecommentaar?
Commentaar dat het waaróm uitlegt — de bedoeling, een aanname, de reden voor een ongebruikelijke keuze — niet het wát, dat de code al zegt. "// verhoog i met 1" is ruis; "waarom hier een retry" is waardevol. De prompt schrijft het zo en laat het overbodige weg.
Wat hoort er in een docstring?
Wat de functie doet, de parameters, wat hij teruggeeft, en welke uitzonderingen hij kan gooien — beschreven voor wie de functie gebruikt zonder de implementatie te lezen. De prompt schrijft docstrings in jouw conventie (JSDoc, Google-style, enz.).
Probeer ook
Prompts die goed combineren met deze
Code · Beste in ChatGPT
Documentatie of README schrijven
Met deze AI-prompt schrijf je als developer documentatie of een README die anderen écht verder helpt — duidelijk hoe je het installeert, gebruikt en bijdraagt, zonder de kennis die alleen jij hebt voor te veronderstellen.
Bekijk promptCode · Beste in Claude
Code uitleggen of legacy begrijpen
Met deze AI-prompt begrijp je als developer onbekende of legacy code snel — stap voor stap uitgelegd wat het doet, waarom, en waar de risico’s zitten.
Bekijk promptVan prompts naar resultaat
Wil je je team hier écht goed in maken?
Losse prompts kopiëren is een goed begin. In een hands-on training of begeleidingstraject leren we je team AI dagelijks, veilig en effectief inzetten — op jullie eigen werk, met jullie eigen voorbeelden.
- Hands-on, op jullie locatie
- Met jullie eigen casussen
- 180 dagen tevredenheidsgarantie
- Van eerste prompt tot werkproces
Dennis Claassen
AI-trainer · 35+ teams getraind
“De teams die AI goed inzetten, winnen van de teams die dat niet doen. Wij zorgen dat jullie bij de eerste groep horen.”