1. Як писати коментарі
У Python, як і в багатьох інших мовах програмування, можна писати коментарі у коді.
Коментарі — це просто текст для інших програмістів: Python-інтерпретатор ніяк на них не реагує і не виконує записаний в них код. Коментарі допомагають програмістам та іншим учасникам проєкту розуміти код, що особливо корисно при спільній роботі та довготривалій підтримці програм. У Python є декілька способів додавання коментарів у код.
Однорядкові коментарі:
Починаються зі символу #. Усе, що йде після # у тій самій рядку, інтерпретатор Python ігнорує. Цей тип коментарів зазвичай використовується для коротких зауважень або пояснень до певного рядка коду. Приклад:
# Це однорядковий коментар
print("Hello, World!") # Пояснення до дії функції
Багаторядкові коментарі:
У Python офіційно немає спеціального синтаксису для багаторядкових коментарів, але їх можна створити за допомогою декількох однорядкових коментарів або використовувати потрійні лапки, хоча останнє насправді є багаторядковим текстовим літералом, який не виконується як код. Приклад:
# Це приклад багаторядкового коментаря
# Кожен рядок починається з символу `#`
або:
""" Це багаторядковий літерал, який може використовуватися як коментар. Python інтерпретує його як рядок, але нічого не робить з цим рядком, якщо він не присвоєний змінній або не використовується у виразі. """
Корисно! Літерал — це маленький шматочок даних записаних прямо у коді: число, рядок тощо.
2. Навіщо писати коментарі
Використання коментарів у коді підвищує його читабельність, полегшує підтримку і оновлення, а також сприяє більш ефективній колаборації у командах. Коментарі повинні бути короткими, але інформативними та актуальними, щоб слугувати корисною документацією коду і не захаращувати його зайвою інформацією.
Документуючі рядки (docstrings):
Це багаторядкові рядки, які зазвичай розташовуються на початку модулів, класів, методів і функцій для опису їхнього призначення. Вони укладаються у три пари подвійних лапок і використовуються для автоматичного створення документації.
Приклад:
def add(a, b): """ Функція для додавання двох чисел. :param a: перший доданок :param b: другий доданок :return: сума a і b """ return a + b
У світі програмування розробники інколи додають у свій код коментарі, які не лише слугують поясненнями, але й викликають усмішку. Ось кілька прикладів веселих коментарів, які можна зустріти у коді:
Приклад 1:
# Я б пояснив, що тут відбувається, але навіть мені вже не зрозуміло.
Приклад 2:
# Якщо це не працює, винен хтось інший.
Приклад 3:
# Прийшов, побачив, виправив... і зламав.
Приклад 4:
# Коли я написав це, лише я і Бог знали, як це працює.
# Тепер знає тільки Бог.
Приклад 5:
# Кількість годин витрачених тут марно = 42.
Ці коментарі можуть додати легкості та гумору у процес розробки, роблячи кодові бази менш монотонними. Вони також нагадують про те, що розробка програмного забезпечення — це творчий та людський процес.
3. Швидко закоментувати код
У PyCharm IDE ви можете швидко закоментувати або розкоментувати код, використовуючи гарячі клавіші. Для цього виділіть рядки коду, які хочете закоментувати або розкоментувати, і натисніть Ctrl + / на Windows (або Cmd + / на macOS). Ця комбінація клавіш застосовує або видаляє символ коментаря на кожному виділеному рядку, роблячи цей процес швидким та ефективним.
ПЕРЕЙДІТЬ В ПОВНУ ВЕРСІЮ