Пошук уроків, статей та іншого контенту
Варіанти коментарів в JavaScript та як писати корисні коментарі
Коментарі — текст у коді, який JavaScript не виконує.
Вони допомагають пояснювати складні рішення та залишати корисні примітки.
Використовуються:
//Наприклад:
// Ціна товару без знижки
const price = 1000;Або:
const discount = 0.1; // 10%Використовуються:
/*
comment
*/Наприклад:
/*
Розраховуємо фінальну ціну
з урахуванням знижки користувача
*/
const finalPrice = price - price * discount;Поганий коментар:
// Збільшуємо counter на 1
counter++;Код і так це показує.
Корисніший приклад:
// Пропускаємо перший елемент, оскільки це службовий запис
const users = data.slice(1);Коментар пояснює причину рішення.
У коді часто зустрічаються:
// TODO: додати валідацію emailАбо:
// FIXME: виправити неправильне округленняТакі позначки допомагають залишати технічні нагадування.
Але вони не повинні перетворюватися на заміну нормальній системі задач.
Під час навчання можна побачити:
// console.log(user);Так код тимчасово не виконується.
Проте великі шматки старого закоментованого коду краще не зберігати без причини — у реальних проєктах історію змін зберігають системи контролю версій, наприклад Git.
Коментувати очевидне.
// Створюємо змінну name
const name = "Anna";Такий коментар майже нічого не додає.
Не оновлювати коментар після зміни коду. Застарілий коментар іноді небезпечніший за його відсутність.
Пояснювати поганий код коментарями замість його спрощення. Якщо код можна зробити зрозумілим сам по собі — краще зробити саме так.
JavaScript підтримує:
// однорядковий коментар
/*
багаторядковий
коментар
*/Хороший коментар не повторює код, а пояснює контекст, причину або неочевидне рішення.