JavaScript с нуля

Глава 6. Комментирование кода… что за?!

Кажется, что все, что мы пишем в редакторе кода, предназначено исключительно для браузера:

let xPos = -500;

function boringComputerStuff() {

xPos += 5;

if (xPos > 1000) {

xPos = -500;

}

}

boringComputerStuff();

Но скоро мы убедимся, что это совсем не так. У кода есть и другая аудитория — люди.

Код часто используют или читают другие. В особенности если вы работаете в одной команде с другими разработчиками. Чтобы на выходе код выглядел максимально эффективным, нужно убедиться, что он понятен другим. Это касается и тех, кто работает независимо. Любая прекрасная функция, которая кажется логичной сегодня, может выглядеть полной чушью через неделю.

Есть множество способов решения этой проблемы. Один из лучших — это использование комментариев. В этом коротком разделе мы ответим на вопрос, что такое комментарии, узнаем, как они обозначаются в JavaScript, и рассмотрим правильные способы их использования.

Поехали!