База знанияИзпитен център
BGБългарски
Избери език13

CKTIS / JavaScript

Коментари и документация

Коментарите описват замисъла на кода, без съдържанието им да се изпълнява. Запознайте се със синтаксиса // и /* ... */, конвенцията за документация /** ... */ и влиянието на знаците за край на ред върху анализа на програмата.

Версия: ECMAScript and Web APIs; exact feature edition and browser support reviewed per entry; Node 24 in repository does not prove browser API support

Синтаксис

// comment
/* block comment */
/** documentation comment */

Коментарите обясняват кода, особено причините за решенията и ограниченията. Съдържанието им не се изпълнява като JavaScript. Редакционна препоръка: обяснявайте най-вече „защо“, вместо да повтаряте какво прави очевидната инструкция.

// започва коментар, който продължава до края на реда или на изходния текст; знакът за край на ред не е част от коментара. /* ... */ може да заема част от ред или няколко реда и завършва при първото */. Блоковите коментари не могат да се влагат един в друг.

За ECMAScript /** ... */ е обикновен блоков коментар. Документационният запис не променя поведението на функция и не налага типове; тълкуването на допълнителни анотации е задача на инструментите, а не част от синтаксиса на езика.

Коментарите се държат като празни пространства, с едно важно изключение: блоков коментар, съдържащ знак за край на ред, се третира като край на ред при синтактичния анализ. Това може да повлияе на автоматичното вмъкване на точка и запетая (ASI), например след return. Не отделяйте return от връщаната стойност с такъв коментар. Отделната форма #! е разрешена само в самото начало на изходния текст на Script или Module.

Примери

/** Compute the total price. */
function total(price, quantity) {
  // Keep the calculation in one place.
  return price * quantity;
}

const result = total(7, /* quantity */ 3);
console.log(result);

Резултат

21

Показаният код и заявеният резултат са проверени в изолирана среда по метода, записан в доказателството за проверка на тази точна версия.

Източници