Как писать комментарии, объясняющие решения в коде.
Комментарии должны объяснять намерение или неочевидное ограничение. Пересказ простой строки кода добавляет шум.
Адаптируйте процесс под свою задачу.
Определите неочевидную причину, инвариант или ограничение и объясните рядом с соответствующей операцией. Удалите комментарии, лишь пересказывающие простой синтаксис, и согласуйте объяснение с реальным поведением.
- Что вы предоставляете
- Код и стиль документации проекта.
- Что вы получите
- Полезные комментарии о намерениях и ограничениях.
Посмотрите входные данные и результат.
Иллюстративные входные и выходные данные · учебный пример, а не реальный запуск WebAct
Полей ввода: Пример
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 }));Готовый пример
// 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.Добавьте эти данные в промпт и скопируйте его в WebAct, чтобы попробовать задачу. Ваш результат может отличаться от примера.
Решения и устранение проблем.
Нужен ли комментарий к каждому присваиванию?
Комментируйте там, где иначе неясны намерение или ограничение. Пересказ кода создаёт работу по сопровождению, не объясняя решение.
Почему полезный комментарий становится обманчивым после рефакторинга?
Проверьте его вместе с изменённым поведением, обновите или удалите устаревшие допущения. Комментарии — часть сопровождаемого объяснения.
Попробуйте на собственном источнике.
Замените пример своим материалом в промпте. Сохраните нужные требования и скопируйте задачу в WebAct.
Настроить и скопировать задачу ↑