У цьому уроці ми навчимося створювати коментарі на Python за допомогою прикладів.
Відео: Коментарі на Python
Коментарі - це описи, які допомагають програмістам краще зрозуміти намір та функціональність програми.
Вони повністю ігноруються інтерпретатором Python.
Переваги використання коментарів
Використання коментарів у програмах робить наш код більш зрозумілим. Це робить програму більш читабельною, що допомагає нам запам'ятати, чому були написані певні блоки коду.
Крім цього, коментарі також можна використовувати для ігнорування деякого коду під час тестування інших блоків коду. Це пропонує простий спосіб запобігти виконанню деяких рядків або написати швидкий псевдокод для програми.
Однорядкові коментарі на Python
У Python ми використовуємо хеш-символ #для написання однорядкового коментаря.
Приклад 1: Написання однорядкових коментарів
# printing a string print('Hello world')
Вихідні дані
Привіт Світ
Ось коментар:
# printing a string
Цей рядок ігнорується інтерпретатором Python.
Все, що настає після #, ігнорується. Отже, ми також можемо написати вищезазначену програму в один рядок як:
print('Hello world') #printing a string
Результат роботи цієї програми буде таким же, як у прикладі 1 . Перекладач ігнорує весь текст після #.
Багаторядкові коментарі в Python
Python не пропонує окремого способу писати багаторядкові коментарі. Однак є й інші способи обійти цю проблему.
Ми можемо використовувати #на початку кожного рядка коментаря кілька рядків.
Приклад 2: Використання декількох #
# it is a # multiline # comment
Тут кожен рядок трактується як окремий коментар, і всі вони ігноруються.
Рядкові літерали для багаторядкових коментарів
Незважаючи на те, що в Python не існує унікального способу писати багаторядкові коментарі, ми знаємо, що інтерпретатор Python ігнорує рядкові літерали, не присвоєні змінній.
Отже, ми навіть можемо написати однорядковий коментар як:
#this is a comment 'this is an unassigned string as a comment '
Тут ми бачимо, що другий рядок програми є рядком, але не присвоєний жодній змінній чи функції. Отже, інтерпретатор ігнорує рядок.
Подібним чином ми можемо використовувати багаторядкові рядки (потрійні лапки) для написання багаторядкових коментарів.
Символ лапки може бути 'або ".
Приклад 3: Використання рядкових літералів для написання багаторядкових коментарів
''' I am a multiline comment! ''' print("Hello World")
Тут багаторядковий рядок не призначається жодній змінній, тому інтерпретатор ігнорує його. Незважаючи на те, що це технічно не багаторядковий коментар, його можна використовувати як один.
Структури Python
За домовленістю, потрійні лапки, що з’являються відразу після визначення функції, методу або класу, є документами (рядками документації).
Документи пов'язані з об'єктами, і доступ до них можна отримати за допомогою __doc__атрибута.
Щоб дізнатись більше, відвідайте документацію Python.
Як писати кращі коментарі?
- Використовуйте коментарі, щоб описати, що робить функція, а не конкретні подробиці того, як це робить функція.
- Спробуйте видалити якомога більше зайвих коментарів. Спробуйте написати код, який може пояснити себе, використовуючи кращий вибір функції / імені змінної.
- Постарайтеся зробити коментарі якомога коротшими та стислими.
