Вивчайте Коментарі | Основи TypeScript

Свайпніть щоб показати меню

П: Що робить програміст, коли йому потрібно написати документацію до свого коду?

В: Він пише її у Word-файлі.

П: Що робить хороший програміст, коли йому потрібно написати документацію до свого коду?

В: Він використовує коментарі.

Давайте зробимо з вас хорошого програміста та навчимо користуватися коментарями у вашому коді. Але спочатку з’ясуємо, що це таке:

У TypeScript існує два типи коментарів:

Можна закоментувати цілий рядок за допомогою //;
Також можна закоментувати блок коду, що займає кілька рядків, або фрагмент однорядкового коду за допомогою /* code */.

Розглянемо приклад, де потрібно закоментувати деякі рядки та написати там коментарі. Повторю, компілятор не буде виконувати або навіть розглядати закоментовані фрагменти коду, тому там можна писати будь-що (крім поганих слів; моя мама сварить мене, якщо я таке пишу).


              12345678
            
console.log("Hello world!") 
// This code performs output of information to the screen.
let word : string = 'c<>definity' 
console.log(`Hello ${word}!`)
/*This code creates a variable of type string 
and uses it for output to the screen. 
We use this variable with the required syntax 
and successfully display text on the screen with the variable. */

Як видно з коду вище, ми закоментували різні фрагменти тексту. У коментарях надаються пояснення щодо того, що відбувається в коді та що виконують певні рядки. Зверніть увагу, що для коментування декількох рядків використовується інший синтаксис коментарів. (/* */) Після // все, що знаходиться праворуч від цих символів, вважається коментарем.

Можна також закоментовувати фрагменти коду. Наприклад, якщо підозрюється помилка в певному рядку, цей рядок можна закоментувати та повторно виконати код для перевірки наявності помилки.


              123
            
//var str = 'Hello World";
var num = 132;
console.log(num/* - str*/);

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

Також не забувайте документувати свій код. Це як поставити пляшку води біля ліжка після вечора з алкоголем.

Все було зрозуміло?

Дякуємо за ваш відгук!

Секція 1. Розділ 6

Запитати АІ

Запитайте про що завгодно або спробуйте одне із запропонованих запитань, щоб почати наш чат

Секція 1. Розділ 6