Écrire des commentaires de code qui expliquent les décisions.
Les commentaires doivent expliquer une intention ou une contrainte peu évidente. Répéter en prose une ligne simple ajoute du bruit.
Adaptez le processus à votre tâche.
Identifiez la raison, l’invariant ou la contrainte non évidente et expliquez-la près de l’opération concernée. Supprimez les commentaires qui racontent simplement une syntaxe claire et alignez l’explication sur le comportement réel.
- Ce que vous fournissez
- Code et style documentaire du projet.
- Ce que vous obtenez
- Commentaires utiles expliquant intention et contraintes.
Consultez les données et le résultat.
Entrée et sortie illustratives · exemple pédagogique, pas une exécution WebAct en direct
Exemple champ
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 }));Exemple complet
// 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.Chargez ces données dans le prompt, puis copiez-le dans WebAct pour essayer la tâche. Votre résultat peut différer de l'illustration.
Décisions et dépannage.
Chaque affectation doit-elle recevoir un commentaire ?
Commentez là où l’intention ou une contrainte serait autrement floue. Répéter le code en prose ajoute de la maintenance sans expliquer une décision.
Pourquoi un commentaire utile devient-il trompeur après refactorisation ?
Revoyez-le avec le comportement modifié et actualisez ou supprimez les hypothèses périmées. Les commentaires font partie de l’explication maintenue.
Essayez avec votre propre source.
Remplacez l'exemple par vos données dans le prompt. Gardez les exigences nécessaires, puis copiez la tâche dans WebAct.
Personnaliser et copier la tâche ↑