Коментарі в коді

5.1 Як писати коментарі

В Python, як і в багатьох мовах програмування, можна писати коментарі в коді. Коментарі допомагають програмістам та іншим учасникам проекту розуміти код, що особливо корисно при спільній роботі та довгостроковому обслуговуванні програм. В Python існує кілька способів додавання коментарів у код.

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

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

# Це однорядковий коментар
print("Hello, World!") # Пояснення до дії функції

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

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

# Це приклад багаторядкового коментаря # Кожний рядок починається з символу #
      

або:

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

5.2 Навіщо писати коментарі

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

Документуючі строки (docstrings):

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

Приклад:

def add(a, b):
""" Функція для додавання двох чисел. :param a: перший доданок :param b: другий доданок :return: сума a і b """
    return a + b

У світі програмування іноді розробники додають в свій код коментарі, які не лише служать поясненнями, але й змушують усміхнутися. Ось кілька прикладів кумедних коментарів, які можна зустріти в коді:

Приклад 1

 

            # Я б пояснив, що тут відбувається, але навіть мені вже не зрозуміло.
        

Приклад 2

 

    # Якщо це не працює, то винен хтось інший.

Приклад 3

 

    # Прийшов, побачив, виправив... і зламав.

Приклад 4

 

    # Коли я написав це, лише я і Бог знали, як це працює. 
    # Тепер знає тільки Бог.

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

5.3 Швидко закоментувати код

В PyCharm ви можете швидко закоментувати або раскоментувати код, використовуючи гарячі клавіші. Для цього виділіть рядки коду, які хочете змінити, і натисніть Ctrl + / на Windows (або Cmd + / на macOS). Ця комбінація клавіш додає або прибирає символ коментаря на кожному виділеному рядку, роблячи процес швидким і ефективним.

1

Опитування

Вирази та типи, рівень 3, лекція 4

Недоступний

Вирази та типи

Вирази та типи

Відкрити