Codecommentaar schrijven dat beslissingen uitlegt.
Commentaar moet de bedoeling of een niet-vanzelfsprekende beperking uitleggen. Een simpele coderegel in proza herhalen voegt ruis toe.
Stem de werkwijze af op je taak.
Vind de niet-vanzelfsprekende reden, invariant of beperking achter de code en leg die bij de relevante bewerking uit. Verwijder commentaren die alleen simpele syntaxis navertellen en houd uitleg afgestemd op echt gedrag.
- Wat je aanlevert
- Code en documentatiestijl van het project.
- Wat je krijgt
- Nuttige commentaren over bedoeling en beperkingen.
Bekijk de invoer en het resultaat.
Illustratieve invoer en uitvoer · een leervoorbeeld, geen live uitvoering van WebAct
Voorbeeld invoerveld
Add an intent comment to this JavaScript mapping. Original row IDs must remain available so reviewers can trace comparison results to their sources.
const copied = rows.map(row => ({ ...row }));Uitgewerkt voorbeeld
// Retain source row IDs so reviewers can trace each comparison finding.
const copied = rows.map(row => ({ ...row }));
The comment explains why the IDs remain. The code still makes shallow copies; nested objects are shared.Laad deze invoer in de prompt en kopieer deze naar WebAct om de taak te proberen. Je resultaat kan afwijken van het voorbeeld.
Keuzes en probleemoplossing.
Moet elke toewijzing een commentaar krijgen?
Geef commentaar waar bedoeling of beperking anders onduidelijk is. Code in proza herhalen voegt onderhoud toe zonder een beslissing uit te leggen.
Waarom wordt nuttig commentaar misleidend na een refactor?
Bekijk het met het gewijzigde gedrag en werk oude aannames bij of verwijder ze. Commentaar is onderdeel van de onderhouden uitleg.
Probeer het met je eigen bron.
Vervang het voorbeeld door je eigen materiaal in de taakprompt. Behoud de eisen die je nodig hebt en kopieer de taak naar WebAct.
De taak aanpassen en kopiëren ↑