Введение в комментарии и читаемость кода

Комментарии используются для пояснения кода и повышения его читаемости. Интерпретатор Python игнорирует их, и они не влияют на выполнение программы.

В этом уроке Вы научитесь использовать комментарии и писать чистый, понятный код.

Однострочные комментарии

Однострочные комментарии начинаются с символа #. Всё после # в этой строке игнорируется Python. Например:

# This is a single-line comment
print("Hello, World!")

Многострочные комментарии

Многострочные комментарии можно записывать с помощью тройных кавычек (''' или """). Например:

"""
This is a multi-line comment.
It spans multiple lines.
"""
print("Hello, World!")

Зачем нужны комментарии?

Комментарии помогают:

• Пояснять сложный код.
• Делать код понятнее для других людей и для Вас в будущем.
• Выполнять отладку и находить причины неполадок.

Помните: комментарии предназначены для людей, а не для компьютера!

Правила написания хороших комментариев

Вот несколько советов по написанию хороших комментариев:

• Делайте комментарии краткими и содержательными.
• Избегайте очевидных комментариев, таких как # Increment x by 1 для x = x + 1.
• Используйте комментарии, чтобы объяснить, почему код написан именно так.

Повышение читаемости кода

Читаемый код проще сопровождать и отлаживать. Вот несколько советов:

• Используйте понятные имена переменных и функций.
• Делайте строки кода короткими.
• Организуйте код по разделам с помощью комментариев.

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

Комментарии можно использовать, чтобы временно отключать код для целей отладки. Например:

# print("This line is commented out and won’t run.")
print("This line will run.")

Пример: документирование функции

С помощью комментариев можно документировать функции и объяснять их назначение:

def greet(name):
    # This function greets the user by their name.
    print("Hello,", name)

greet("Alice")

Что мы узнали?

В этом уроке Вы узнали:

• Как писать однострочные и многострочные комментарии в Python.
• Почему комментарии важны для читаемости и сопровождаемости кода.
• Рекомендации по написанию комментариев и повышению читаемости кода.

Отличная работа! Переходим к следующей теме.