Begeleid mij bij het schrijven van zelfdocumenterende en leesbare code
description
Met deze prompt krijg je concrete adviezen om je code zo te schrijven dat deze zonder veel extra uitleg begrijpelijk is voor anderen. Dit bevordert samenwerking, vermindert fouten bij onderhoud en maakt de code toekomstbestendig. Het helpt je om te focussen op duidelijkheid en eenvoud, in tegenstelling tot alleen refactoren of het toepassen van design patterns.
prompt
Help mij mijn code te herschrijven zodat deze zelfdocumenterend is en zeer leesbaar voor andere ontwikkelaars. Codevoorbeeld of omschrijving van mijn code: ...
try_prompt
generate_helper
disclaimerOnPageApi
tags
ai_answers
provider: openai
model: gpt-4.1-nano
Natuurlijk! Hier is een herschreven versie van je functie die zelfdocumenterend is en gemakkelijk te begrijpen voor andere ontwikkelaars:
```javascript
/**
* Bereken het te betalen belasting op basis van het inkomen.
*
* @param {number} brutoInkomen - Het bruto inkomen van de persoon.
* @returns {number} Het bedrag aan belasting dat betaald moet worden.
*/
function berekenBelasting(brutoInkomen) {
const belastingTarief = 0.3; // 30% belastingtarief
const teBetalenBelasting = brutoInkomen * belastingTarief;
return teBetalenBelasting;
}
```
**Wat is verbeterd?**
- De naam van de parameter is verduidelijkt naar `brutoInkomen`.
- Er wordt een constante `belastingTarief` gebruikt, waardoor het duidelijk is dat dit een vaste waarde is.
- De berekening wordt in een aparte variabele opgeslagen, wat de leesbaarheid verhoogt.
- Een commentaar en JSDoc-stijl documentatie is toegevoegd, zodat duidelijk is wat de functie doet, welke parameter wordt verwacht, en wat wordt geretourneerd.
Wil je dat ik de code verder uitbreid of aanpas?
provider: deepseek
model: deepseek-chat
Zeker! Hier is een herschreven versie met zelfdocumenterende code:
```javascript
function berekenInkomstenbelasting(brutoJaarinkomen) {
const BELASTINGPERCENTAGE = 0.3;
const belastingBedrag = brutoJaarinkomen * BELASTINGPERCENTAGE;
return belastingBedrag;
}
```
**Verbeteringen:**
- **Betekenisvollere functienaam**: `berekenInkomstenbelasting` specificeert wat er precies berekend wordt
- **Duidelijke parameternaam**: `brutoJaarinkomen` in plaats van algemene `inkomen`
- **Constante voor magic number**: `BELASTINGPERCENTAGE` maakt de 0.3 begrijpelijk
- **Tussenvariabele**: `belastingBedrag` verduidelijkt het resultaat voordat het wordt teruggegeven
- **Consistente naamgeving**: CamelCase voor variabelen, hoofdletters voor constanten
Deze versie is direct begrijpelijk zonder extra comments nodig te hebben.