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

Що таке багаторядковий коментар у Python?

Багаторядкові коментарі в Python стосуються блоку тексту або операторів, які використовуються для пояснення або документації в коді. На відміну від однорядкових коментарів, позначених символом решітки (#), багаторядкові коментарі взяті в потрійні подвійні лапки (``) або потрійні одинарні лапки (`’`). Ці коментарі часто використовуються для надання детальних пояснень, документації або приміток щодо коду, і вони можуть займати кілька рядків. Хоча Python не має спеціального синтаксису для багаторядкових коментарів, використання потрійних лапок досягає подібного ефекту, оскільки інтерпретатор ігнорує укладений текст.

Типи багаторядкових коментарів у Python

Є два способи, якими ми можемо додати багаторядкові коментарі Python у наш код. Вони такі:

зображення як фон в css

• Послідовний однорядковий коментар
• Використання багаторядкового рядка як коментаря
• Використання методу зворотної косої риски

Закоментуйте кілька рядків у Python за допомогою послідовних однорядкових коментарів

в Python , символ решітки (#) використовується для коментаря до рядка. Однолінійний коментарі на Python не обов’язково бути лише текстом для пояснення коду, вони також можуть бути використані для запобігання Python від виконання коду. Символ решетки слід розміщувати перед кожним рядком, щоб вважатися багаторядковими коментарями в Python.

Приклад: послідовний однорядковий коментар

Тут перші два рядки містять символ решетки (#), і інтерпретатор запобігає виконанню двох рядків. Потім він друкує коментарі Python і, нарешті, запобігає виконанню останнього рядка.

# Write Python3 code here # Single line comment used print('Python Comments') # print('Mathematics')>

Вихід:

Python Comments>

Закоментуйте кілька рядків у Python, використовуючи багаторядковий рядок як коментар

Багаторядкові коментарі Python також можуть бути укладені в роздільник (). Знову не повинно бути пробілу між роздільниками (). Вони корисні, коли текст коментаря не вміщується в один рядок, тому має охоплювати кілька рядків. Цей тип рядкового літералу ігнорується, оскільки він не присвоюється жодній змінній. Ми можемо отримати доступ до цих рядків за допомогою __doc__.

Приклад: використання багаторядкового рядка як коментаря

Багаторядкові коментарі використовуються для коментування більш ніж одного рядка. Перший рядок — однорядковий коментар. Другий і третій рядки можна прокоментувати за допомогою потрійних лапок ( ). Це перешкоджає виконанню наведеного вище коду. Нарешті, він друкує математику у вихідних даних. Однак, якщо ці багаторядкові коментарі Python розміщуються безпосередньо після сигнатури функції чи класу, вони перетворюються на рядки документів .

# Write Python code here ''' Multi-line comment used print('Python Comments') ''' print('Mathematics')>

Вихід:

Mathematics>

Закоментуйте кілька рядків у Python за допомогою методу зворотної косої риски

Метод створення багаторядкових коментарів у Python передбачає використання зворотної похилої риски (``) у кінці кожного рядка для використання функції продовження рядка, таким чином дозволяючи коментарю поширюватися на наступний рядок. Цей метод продовження рядка менш поширений, ніж інші підходи, такі як послідовні однорядкові коментарі або багаторядкові рядки, і в основному використовується для читання коду, коли необхідно розбити коментар на кілька рядків.

приклад : у цьому прикладі коментарі починаються з#>розширюються на кілька рядків за допомогою зворотної косої риски (>) в кінці кожного рядка. Зворотний слеш означає, що коментар продовжується в наступному рядку. Цей метод може бути корисним для покращення читабельності коду, якщо у вас є довгі коментарі.

# Using backslash for multiline comments # This is a long comment  # that spans multiple lines  # using the backslash continuation method. # Code continues below print('Hello, World!')>

Вихід:

Hello, World!>

Рядки документів у Python

The рядок документації це вбудована функція Python, яка використовується для зв’язування документації, написаної з модулями, функціями, класами та методами Python. Він додається безпосередньо під функціями, модулями або класами, щоб описати, що вони роблять. У Python рядок документації стає доступним через Python __doc__ атрибут.

Приклад: Docstrings у Python

У цьому прикладі після визначення функції multiply() ми оголосили коментар рядка документа, використовуючи потрійні лапки. Потім ми друкуємо рядок документації за допомогою атрибута __doc__.

def multiply(a, b):  '''Multiplies the value of a and b''' return a*b # Print the docstring of multiply function print(multiply.__doc__)>

Вихід:

Multiplies the value of a and b>

Різниця між коментарями та Docstring у Python

Давайте подивимося різницю між коментарями Python і Docstring: