How to use the Code Comment Generator.
Comments should explain intent or a non-obvious constraint. Repeating a straightforward line of code in prose adds noise.
Make the workflow fit your task.
Identify the non-obvious reason, invariant or constraint behind the code and explain that near the relevant operation. Remove comments that merely narrate straightforward syntax, keeping the explanation aligned with actual behavior.
- What you provide
- Code and project documentation style.
- What you get
- Useful comments explaining intent and constraints.
See the input and the result.
Illustrative input and output · a teaching example, not a live WebAct run
Example input
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 }));Completed example
// 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.Load this input into the prompt, then copy it to WebAct to try the task. Your result may differ from the illustration.
Decisions and troubleshooting.
Should every assignment receive a comment?
Comment where intent or a constraint would otherwise be unclear. Repeating the code in prose adds maintenance work without explaining a decision.
Why does a helpful comment become misleading after a refactor?
Review it alongside the changed behavior and update or remove stale assumptions. Comments are part of the maintained explanation.
Try it with your own source.
Replace the example with your material in the task prompt. Keep the requirements you need, then copy the task into WebAct.
Customize and copy the task ↑