Коментари в JavaScript

• Април 28, 2024

Коментарите са точно това, коментари, които поставяте в своя JavaScript или HTML, за да обясните какво се случва. Има няколко начина да добавите коментари във вашия JavaScript код. Синтаксис за коментар - как да кажем на скрипта или документа, че нещо е коментар, а не данни или код - е много просто. Писането на добри коментари е по-трудно и от гледна точка на кода (включен мой собствен), най-трудната част изглежда всъщност се справя!

JavaScript има 2 вида коментари, един ред коментар и многоредов коментар.

Коментарът на един ред в JavaScript започва с две предни наклонени черти (//) и завършва в края на реда (технически, непосредствено преди символа на терминатора на реда). Коментарите от един ред са особено полезни за кратки бележки.

// Това е един ред коментар
data = "моите данни" // Това също е коментар в един ред

Многоредовният коментар в JavaScript започва с наклонена черта напред, последвана от звездичка (/*) и завършва със звездичка, последвана от наклонена черта напред (*/). Всичко между /* и */ се счита за коментар. Този тип коментар може да обхваща няколко реда. Също така е възможно този тип коментар да се постави в средата на ред код, ако той не обхваща няколко реда, но това рядко е полезно.

/ * това е ред от многоредов коментар
това все още е част от коментара ми
това е последната част от коментара ми * /

/ * това е многоредов коментар в стил на един ред * /

Често виждате допълнителни звездички, добавени към многоредови коментари, за да създадете декоративни информационни полета, като например:

/*********************
* Моите функции *
*********************/

Многоредовите функции са особено полезни в началото на програма или раздел от програмата, за да се опише какво е предназначена да прави програмата и как я прави.

Коментарите се използват за две цели. Докато пишете код (или дори преди да го напишете!), Трябва да напишете коментари, които ще позволят на друг човек да разбере какво прави програмата (или се предполага, че прави.) Дори и да не очаквате някой друг да чете някога вашия код, ще се изненадате колко можете да забравите, ако искате да направите промени след няколко седмици или месеци.

Също така, особено в езици за скриптове като JavaScript, коментарите често се използват като част от процеса на отстраняване на грешки. Можете да въведете код, който да използвате за отстраняване на грешки, и да ги коментирате, когато приключите с тях, или да коментирате секции от код, които смятате, че създават проблеми или се променят, за да добавите нова функционалност. Когато правите това, бъдете особено внимателни, за да не поставите коментар в една линия пред началото на многоредов коментар. Това коментира останалата част от многоредовия коментар, който почти сигурно ще доведе до грешка.

Инструкции Видео: JavaScript Урок 7 - Коментари (Април 2024).