Коментарі в JavaScript

• Може 17, 2024

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

У JavaScript є два типи коментарів, однорядковий коментар та багаторядковий коментар.

Коментар до одного рядка в JavaScript починається з двох передніх косої риски (//) і закінчується в кінці рядка (технічно безпосередньо перед символом термінатора рядка). Однорядкові коментарі особливо корисні для коротких нотаток.

// Це однорядковий коментар
data = "мої дані" // Це також коментар в одному рядку

Багаторядковий коментар у JavaScript починається з нахилу вперед, а потім зірочкою (/*) і закінчується зірочкою з подальшим нахилом вперед (*/). Все між /* і */ вважається коментарем. Цей тип коментаря може охоплювати кілька рядків. Можна також розмістити цей тип коментаря посеред рядка коду, якщо він не охоплює кілька рядків, але це рідко корисно.

/ * це рядок першого багаторядкового коментаря
це все-таки частина мого коментаря
це остання частина мого коментаря * /

/ * це багаторядковий коментар до одного рядка * /

Ви часто бачите додаткові зірочки, додані до багаторядкових коментарів, щоб створити декоративні інформаційні поля, наприклад:

/*********************
* Мої функції *
*********************/

Багаторядкові функції особливо корисні на початку програми або розділу програми для опису того, що програма призначена робити і як це робить.

Коментарі використовуються для двох цілей. Під час написання коду (або навіть перед тим, як його написати!), Ви повинні написати коментарі, які дозволять іншій людині зрозуміти, що робить програма (чи передбачається, що вона робить). Навіть якщо ви не очікуєте, що хтось ще прочитає ваш код, ви здивуєтеся, скільки ви можете забути, якщо хочете внести зміни через кілька тижнів чи місяців.

Також, особливо в мовах скриптів, таких як JavaScript, коментарі часто використовуються як частина процесу налагодження. Ви можете ввести код для налагодження і прокоментувати їх, коли ви їх використовуєте, або прокоментувати розділи коду, які, на вашу думку, спричиняють проблеми або змінюються, щоб додати нову функціональність. Коли ви робите це, будьте особливо обережні, щоб не ставити коментар до одного рядка перед початком багаторядкового коментаря. Це коментує решту багаторядкових коментарів, що майже напевно спричинить помилку.

Відео Інструкція: Розіграш за коментарі (Може 2024).