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.
Эти комментарии могут добавить легкость и юмор в процесс разработки, делая кодовую базу менее монотонной. Они также напоминают о том, что разработка программного обеспечения — это творческий и человеческий процесс.
5.3 Быстро закомментировать код
В PyCharm IDE вы можете быстро закомментировать или раскомментировать код, используя горячие клавиши. Для этого выделите строки кода, которые хотите закомментировать или раскомментировать, и нажмите Ctrl + / на Windows (или Cmd + / на macOS). Эта комбинация клавиш применяет или удаляет символ комментария на каждой выделенной строке, делая этот процесс быстрым и эффективным.
ПЕРЕЙДИТЕ В ПОЛНУЮ ВЕРСИЮ