Коментарі в Python

 15957

Коментарі — це описи коду, які допомагають усім, хто читає, краще зрозуміти, що і навіщо робить код. Коментарі повністю ігноруються (тобто не виконуються) інтерпретаторами та призначені для колег-програмістів. Наприклад:

Тут коментарями є наступні рядки:

   # Ініціалізуємо дві змінні

   # Виводимо результат на екран

Типи коментарів у Python

У Python є 2 типи коментарів:

   однорядкові коментарі;

   багаторядкові коментарі.

Однорядкові коментарі в Python

Однорядковий коментар починається та закінчується на одному рядку. Символ # використовується для написання однорядкового коментаря. Наприклад:

Результат:

Eric Cartman

Тут у коді два однорядкові коментарі:

   # Створюємо змінну

   # Виводимо значення змінної на екран

Також можна використовувати однорядковий коментар у рядку разом із кодом:

Тут код до # — виконується, а код після # — ігнорується інтерпретатором.

Багаторядкові коментарі в Python

Python не пропонує окремого способу написання багаторядкових коментарів. Проте є варіанти оминути цю заборону.

Рішення №1: Використовувати # відразу в декількох рядках, щоб таким чином зробити багаторядковий коментар. Наприклад:

Тут кожен рядок розглядається як однорядковий коментар і всі вони ігноруються інтерпретатором Python.

Рішення №2: Використовувати потрійні лапки — ''' або """.

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

Розглянемо на практиці:

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

Користь від коментарів у Python

#1. Роблять код зрозумілішим.

Якщо писати коментарі в коді, то цей код буде легше використовувати в майбутньому. Крім того, іншим розробникам буде легше зрозуміти цей код.

#2. Допомагають під час відлагодження коду.

Якщо ми отримаємо помилку під час роботи програми, то ми можемо закоментувати рядок коду, який викликає помилку, замість того, щоб видаляти його. Наприклад:

Тут рядок print('Error Line ) викликає помилку, тому ми зробили його коментарем. Тепер програма працює без помилок.

Це один з наочних прикладів того, як коментарі можуть стати корисним інструментом відлагодження коду.

Примітка: Завжди використовуйте коментарі, щоб пояснити, чому ви щось зробили, а не як ви це зробили. Коментарі не повинні бути описом погано написаного коду.

Оцінити статтю:

1 Зірка2 Зірки3 Зірки4 Зірки5 Зірок (26 оцінок, середня: 4,81 з 5)
Завантаження...

Залишити відповідь

Ваш E-mail не буде опублікований. Обов'язкові поля відмічені *