Привычка ИИ: комментарии-шум
Хороший комментарий объясняет ПОЧЕМУ код такой. Плохой повторяет ЧТО он делает — это и так видно из кода. ИИ почти всегда пишет именно второй тип. Это шум.
Признак шума: комментарий = пересказ кода
// Объявляем переменную для налога перед строкой const tax = price * rate. Это не комментарий, это субтитры. Удалите — код становится короче и читается лучше.
Хорошие комментарии редки
Комментарий уместен когда: 1) объясняет нелогичное решение («так выглядит странно, но иначе ломает Safari»). 2) указывает на скрытое требование. 3) ссылается на тикет/баг. Если ничего из этого — удалите.
Имена > комментарии
Лучший «комментарий» — хорошее имя переменной или функции. parseUserInput понятнее чем // парсим ввод пользователя над функцией с именем p.
примерjavascript
// AI любит писать комментарии-шум, повторяющие сам код.
function calculateTax(price, rate) {
// Объявляем переменную для налога
const tax = price * rate;
// Возвращаем налог
return tax;
}
// Цикл от 0 до длины массива
for (let i = 0; i < items.length; i++) {
// Получаем элемент
const item = items[i];
// Если элемент активен
if (item.active) {
// Добавляем в результат
result.push(item);
}
}Все комментарии здесь — лишние. Удалите их и код не потеряет смысла.
проверь себя
01Какой из этих комментариев — шум?
02Что лучше — хороший комментарий или хорошее имя?
03Когда комментарий действительно полезен?