Коментування початкового коду

Замість епіграфу: "Код має бути написаний так, щоб він сам був документацією до себе".

Коментар — це певний текст у початковому коді призначений для людини. Коментарі ігноруються інтерпретатором і ніяк не впливають на роботу програми.

Коментарі бувають однорядкові і багаторядкові.

Однорядковий коментар

Однорядковий коментар починається з символа '#'. Цей символ і усі символи до кінця рядка початкового коду — це коментар.

# Це простий однорядковий коментар
counter = 0 # описуємо змінну

За допомогою коментарів можна екранувати код від виконання:

# наступний рядок не буде виконуватись
# counter = 0

Коментарі слід писати так, щоб вони пояснювали код, а не дублювали його.
Приклад не самого вдалого коментаря:

discount = 0 # обнуляємо знижку
price = price * 1.2 # додаємо до ціни 20%

Більш вдалий варіант коментаря:

discount = 0 # для незареєстрованих покупців
price = price * 1.2 # +ПДВ 20%

Багаторядковиий коментар

Коментар може займати декілька рядків, у цьому випадку його оточують потрійними лапками чи апострофами:

"""
Я теж коментар,
але я дуже нахабний
і займаю декілька рядків!
"""

Ще приклад багаторядкового коментаря, більш практичний:

'''
--------------------------------------------------
Модуль                  : main.py
Автор                   : Гаврик Попандупало (popandupalo@nowhere.com)
Модифіковано востаннє   : 2019-06-01

Призначення: цей код нічого не робить.
--------------------------------------------------
'''