Коментарі в Python це рядки в коді, які ігноруються інтерпретатором під час виконання програми.
# I am single line comment> > > ''' Multi-line comment used> print('Python Comments') '''> |
>
>
Коментарі покращують читабельність коду та допомагають програмістам дуже уважно розуміти код. Це також допомагає у співпраці з іншими розробниками, оскільки додавання коментарів полегшує пояснення коду.
Типи коментарів у Python
У Python є три типи коментарів:
- Однорядкові коментарі
- Багаторядкові коментарі
- Рядкові літерали
- Коментарі рядка документів
Коментарі в Python
На прикладі видно, що Python Коментарі ігноруються інтерпретатором під час виконання програми.
Python3
# sample comment> name>=> 'geeksforgeeks'> print>(name)> |
>
>
Вихід:
geeksforgeeks>
Чому коментарі використовуються в Python?
Коментарі були невід’ємною частиною мов програмування, і кожна мова має різні способи використання коментарів.
Як і будь-яка інша мова, коментарі в Python служать наступним цілям:
- Покращення читабельності коду
- Пояснення коду іншим
- Розуміння коду, якщо його вивчати через деякий час
- Документування кроків і потреб для функції
- Обмін кодом з іншими розробниками
- Співпраця з кількома людьми.
Типи коментарів у Python
Давайте дізнаємось про різні типи коментарів, як їх використовувати та коли?
1. Однорядковий Коментарі
- Однорядковий коментар Python починається із символу хештегу (#) без пробілів і триває до кінця рядка.
- Якщо коментар перевищує один рядок, додайте хештег у наступний рядок і продовжуйте коментар Python.
- Однорядкові коментарі Python виявилися корисними для надання коротких пояснень для змінних, оголошень функцій і виразів. Перегляньте наведений нижче фрагмент коду, що демонструє однорядковий коментар:
приклад:
Python3
# Print techcodeview.com ! to console> print>(>'techcodeview.com'>)> |
>
>Вихід
techcodeview.com>
2. Багаторядкові коментарі
Python не надає можливості для багаторядкові коментарі . Однак є різні способи, за допомогою яких ми можемо писати багаторядкові коментарі.
перейменувати папку linux
a) Багаторядкові коментарі з використанням кількох хештегів (#)
Ми можемо використовувати кілька хештегів (#), щоб писати багаторядкові коментарі на Python. Кожен рядок розглядатиметься як однорядковий коментар.
Python3
# Python program to demonstrate> # multiline comments> print>(>'Multiline comments'>)> |
>
>Вихід
Multiline comments>
Також перевірте: Цікавий факт про багаторядкові коментарі Python
3. Рядкові літерали
Python ігнорує рядкові літерали які не присвоєні змінній, тому ми можемо використовувати ці рядкові літерали як коментарі Python .
a) Однорядкові коментарі з використанням рядкових літералів
Під час виконання наведеного вище коду ми бачимо, що виводу не буде, тому ми використовуємо рядки з потрійні лапки () як багаторядкові коментарі.
Python3
'This will be ignored by Python'> |
>
>
b) Багаторядкові коментарі з використанням рядкових літералів
Python3
''' Python program to demonstrate> >multiline comments'''> print>(>'Multiline comments'>)> |
масив байтів до рядка java
>
>Вихід
Multiline comments>
4. Рядок документів
- Документаційний рядок Python це рядкові літерали з потрійними лапками, які з’являються одразу після функції.
- Він використовується для зв’язування документації, написаної з модулями, функціями, класами та методами Python.
- Він додається безпосередньо під функціями, модулями або класами, щоб описати, що вони роблять. У Python рядок документації стає доступним через атрибут __doc__.
приклад:
Python3
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>
Переваги коментарів у Python
Коментарі зазвичай використовуються для таких цілей:
- Читабельність коду
- Пояснення коду або метаданих проекту
- Запобігти виконанню коду
- Включати ресурси
Правильний спосіб писати коментарі
Коментарі призначені для пояснення вашого коду. Розробники використовують здорову практику написання коментарів для кращого розуміння коду.
Нижче наведено кілька порад, які допоможуть зробити ваші коментарі ефективними.
- Коментарі мають бути короткими та точними.
- Використовуйте коментарі лише за необхідності, не захаращуйте свій код коментарями.
- Коментар повинен мати якийсь сенс.
- Уникайте написання загальних або базових коментарів.
- Пишіть коментарі, які є зрозумілими.
Ми обговорили все про коментарі Python, як писати коментарі Python, типи коментарів, які його переваги та правильний спосіб написання коментарів.
Читайте також: Як писати коментарі в Python3?