You don't know js(up & going)

Комментарии в коде
Сотрудник салона сотовой связи может набросать некоторые заметки о
возможностях только что выпущенных телефонов или о новых тарифных планах,
которые предлагает его компания. Эти заметки только для самого сотрудника —
они не предназначены для чтения покупателями. Тем не менее эти заметки
помогают сотруднику улучшить свою работу, документируя все "как" и "почему"
того, что ему следует рассказать покупателям.
Один из самых важных уроков, который вы можете освоить при изучении
программирования - код не только для компьютера. Каждый бит кода также,
если не больше, важен для программиста, как и для компилятора.
Ваш компьютер заботится только о машинном коде, последовательности
бинарных 0 и 1, которые появляются после *компиляции*. Почти бесконечное
количество программ можно написать таким образом, что они скомпилируются в
одинаковую последовательность 0 и 1. Выбор, который вы делаете о том, как
написать программу, имеет значение не только для вас, но и для других членов
вашей команды и даже для будущего вас.
Нужно стремиться писать программы, не только правильно работающие, но и
понятные при чтении. Вы можете пройти долгий путь в этом направлении, к
примеру, выбирая понятные имена для своих переменных (см. «Переменные») и
функций (см. «Функции»).
Но еще одна важная часть этого процесса — это комментарии в коде. Это
кусочки текста в вашей программе, которые вставляются именно для того, чтобы
пояснить какие-то вещи для человека. Интерпретатор/компилятор всегда
игнорирует эти комментарии.

---

Есть масса мнений о том, что делает код хорошо документируемым; тяжело
определить на самом деле абсолютно универсальные правила. Но некоторые
соображения и рекомендации будут весьма полезны:
●
Код без комментариев не оптимален.
●
Слишком много комментариев (по одному на каждую строку кода,
например), возможно, является признаком плохо написанного кода.
●
Комментарии должны объяснять *почему*, а не *что*. Они могут
дополнительно объяснять *как*, когда код особенно сложен.
В JavaScript есть два типа комментариев: однострочный и многострочный.
Пример: