Комментарии являются важной частью любого языка программирования, которые помогают пользователям понять работу блока кода.
Как и другие языки программирования, Python также позволяет нам добавлять комментарии в код.
🐧 Как записать вывод команды top в файл
Мы можем использовать однострочные или многострочные комментарии для блока кода.
Если вам нужно закомментировать несколько соседних строк в файле, то вы можете использовать многострочные комментарии в своем приложении на Python.
В этом уроке вы узнаете о комментировании блоков кода в скриптах Python.
Мы можем использовать тройные кавычки, чтобы закомментировать блок кода в Python.
Вы можете использовать либо тройные одинарные кавычки ”’, либо тройные двойные кавычки «»».
Блоки комментариев в Python
Чтобы закомментировать блок кода в Python, у вас есть два общих варианта:
- Добавить символ # в начало каждой строки блока:
Этот метод полезен для выборочного комментирования строк или при работе с IDE, которая позволяет легко переключать комментарии для выбранных строк. - Окружить блок тройными кавычками (”’ или «»”):
Этот метод превращает блок в многострочную строку. Однако имейте в виду, что если строка не присваивается переменной или не используется в качестве doc-строки, она эффективно работает как комментарий.
Комментирование блоков кода с помощью тройных кавычек
Вот пример программы на Python, демонстрирующий использование строк с тройными кавычками (”’ или «»”) для комментариев.
Строки с тройными кавычками можно использовать для добавления подробных, многострочных комментариев или документации.
# Пример программы, демонстрирующей комментирование строк в тройных кавычках
def greet_user(name):
"""
This function takes a user's name as input
and prints a greeting message.
Parameters:
name (str): The name of the user
Returns:
None
"""
print(f"Hello, {name}! Welcome to the Python program.")
# Вызов функции
greet_user("Rahul")
"""
На этом программа заканчивается. Строки в тройных кавычках полезны для: 1. Написания многострочных комментариев. 2. Документирования функций, классов и модулей (docstrings).
"""Строка с тройными кавычками для документации функции: Внутри функции greet_user используется docstring («»« или „“») для описания назначения, параметров и возвращаемого значения функции.
Строка с тройными кавычками в качестве общего комментария: В конце программы в многострочном комментарии дается дополнительная информация о строках с тройными кавычками.
Заключение
В этом уроке вы узнали о комментировании блока кода в языке программирования Python.
см. также:
- 🐍 Как отправить электронное письмо с помощью python на Linux
- Как установить последнюю версию Python на Ubuntu 20.04
- 🐍 Управление версиями Python с помощью pyenv
- 🐍 Как создать игру “Змейка” на языке Python
- 🐍 Как переключить версию Python на Ubuntu и Debian
