Cómo escribir comentarios de código que expliquen decisiones.
Los comentarios deben explicar la intención o una restricción poco evidente. Repetir en prosa una línea sencilla añade ruido.
Adapta el flujo de trabajo a tu tarea.
Identifica el motivo, invariante o restricción no evidente del código y explícalo junto a la operación pertinente. Elimina comentarios que solo narren una sintaxis simple y alinea la explicación con el comportamiento real.
- Qué aportas
- Código y estilo de documentación del proyecto.
- Qué obtienes
- Comentarios útiles que explican intención y restricciones.
Mira la entrada y el resultado.
Entrada y salida ilustrativas · ejemplo didáctico, no una ejecución de WebAct en directo
Ejemplo campo
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 }));Ejemplo completo
// 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.Carga esta entrada en el prompt y cópialo en WebAct para probar la tarea. Tu resultado puede diferir del ejemplo.
Decisiones y solución de problemas.
¿Debe cada asignación tener un comentario?
Comenta donde la intención o una restricción resultarían poco claras. Repetir el código en prosa añade mantenimiento sin explicar una decisión.
¿Por qué un comentario útil se vuelve engañoso tras refactorizar?
Revísalo junto al comportamiento cambiado y actualiza o elimina supuestos obsoletos. Los comentarios forman parte de la explicación que se mantiene.
Pruébalo con tu propia fuente.
Sustituye el ejemplo por tu material en el prompt. Conserva los requisitos que necesites y copia la tarea en WebAct.
Personalizar y copiar la tarea ↑