Комментарии в коде на Python | Руководство для начинающих

Введение

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

Достижения

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

Skills Graph

%%%%{init: {'theme':'neutral'}}%%%% flowchart RL python(("Python")) -.-> python/BasicConceptsGroup(["Basic Concepts"]) python/BasicConceptsGroup -.-> python/strings("Strings") python/BasicConceptsGroup -.-> python/comments("Comments") subgraph Lab Skills python/strings -.-> lab-72{{"Комментарии в коде на Python"}} python/comments -.-> lab-72{{"Комментарии в коде на Python"}} end

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

В Python для однострочных комментариев используется символ #, который может располагаться в начале или в конце строки кода.

Пример

Откройте файл /home/labex/project/single.py в текстовом редакторе и добавьте однострочный комментарий:

## Output hello string
print('hello')

Альтернативно вы можете разместить комментарий в конце строки кода:

print('hello') ## Output hello string

Однострочные комментарии полезны для предоставления объяснений и уточнений в вашем коде. Они игнорируются при выполнении и служат полезной документацией как для вас, так и для других.

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

Для более umfangных комментариев в Python используются три одинарных кавычки ''' или три двойных кавычки """.

Пример

Откройте файл /home/labex/project/multi1.py в текстовом редакторе и добавьте многострочный комментарий с использованием одинарных кавычек:

'''
This is a multi-line comment using single quotes.
It can be used to provide detailed explanations or instructions.
'''
name = "Tom"
print("Hello, " + name + "!")

Альтернативно откройте файл /home/labex/project/multi2.py в текстовом редакторе и добавьте многострочный комментарий в двойных кавычках:

"""
This is a multi-line comment using double quotes.
It can be used to provide detailed explanations or instructions.
"""
name = "Tom"
print("Hello, " + name + "!")

Многострочные комментарии улучшают читаемость кода и особенно полезны, когда требуются подробные объяснения. Они служат ценной документацией внутри вашего кода.

Резюме

Поздравляем! Вы завершили практическое занятие по комментариям в Python.

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