В этом руководстве вы узнаете о комментариях JavaScript, о том, почему вам следует их использовать и как их использовать с помощью примеров.
Комментарии JavaScript - это подсказки, которые программист может добавить, чтобы облегчить чтение и понимание своего кода. Они полностью игнорируются движками JavaScript.
Есть два способа добавить комментарии к коду:
//- Однострочные комментарии/* */-Многострочные комментарии
Однострочные комментарии
В JavaScript любая строка, которая начинается с символа, //является однострочным комментарием. Например,
name = "Jack"; // printing name on the console console.log("Hello " + name);
Вот // printing name on the consoleкомментарий.
Вы также можете использовать однострочный комментарий следующим образом:
name = "Jack"; console.log("Hello " + name); // printing name on the console
Многострочные комментарии
В Javascript любой текст между /*и */является многострочным комментарием. Например,
/* The following program contains the source code for a game called Baghchal. Baghchal is a popular board game in Nepal where two players choose either sheep or tiger. It is played on a 5x5 grid. For the player controlling the tiger to win, they must capture all the sheep. There are altogether 4 tigers on the board. For the sheep to win, all tigers must be surrounded and cornered so that they cannot move. The player controlling the sheep has 20 sheep at his disposal. */
Поскольку остальная часть исходного кода будет использоваться для реализации правил игры, приведенный выше комментарий является хорошим примером, где вы можете использовать многострочный комментарий.
Использование комментариев для отладки
Комментарии также можно использовать для отключения кода, чтобы предотвратить его выполнение. Например,
console.log("some code"); console.log("Error code); console.log("other code");
Если вы получаете сообщение об ошибке при запуске программы, вместо удаления подверженного ошибкам кода вы можете использовать комментарии, чтобы отключить его от выполнения; это может быть ценным инструментом отладки.
console.log("some code"); // console.log("Error code); console.log("other code");
Совет от профессионала: помните, как использовать комментарии; это может быть действительно полезно. Для большинства редакторов кода это Ctrl + /для Windows и Cmd + /Mac.
Сделайте код более понятным
Как разработчик JavaScript, вам придется не только писать код, но и, возможно, придется изменять код, написанный другими разработчиками.
Если вы будете писать комментарии к своему коду, вам будет легче понять код в будущем. Кроме того, вашим коллегам-разработчикам будет легче понять код.
Как правило, используйте комментарии, чтобы объяснить, почему вы что-то сделали, а не как вы это сделали, и у вас все хорошо.
Примечание: комментарии не должны заменять способ объяснить плохо написанный код на английском языке. Вы всегда должны писать хорошо структурированный и понятный код. А затем используйте комментарии.
