2.5.1.1 Комментарии в коде: почему, как и когда
Вы можете сказать несколько слов, адресованных не Python, а людям, как правило, чтобы объяснить другим читателям кода, как работают трюки, используемые в коде, или значения переменных, и, в конечном итоге, чтобы сохранить информация о том, кто автор и когда была написана программа.
Замечание, вставленное в программу, которое опускается во время выполнения, называется комментарием.
Как оставить такой комментарий в исходном коде? Это должно быть сделано так, чтобы Python не интерпретировал это как часть кода.
Всякий раз, когда Python встречает комментарий в вашей программе, этот комментарий полностью прозрачен для него - с точки зрения Python, это всего лишь один пробел (независимо от того, какова длина настоящего комментария).
В Python комментарий - это кусок текста, который начинается со знака # (решетка) и продолжается до конца строки.
Если вы хотите, чтобы комментарий занимал несколько строк, вы должны поставить перед всеми ними хеш.
Прямо как здесь:
# This program evaluates the hypotenuse c.
# a and b are the lengths of the legs.
a = 3.0
b = 4.0
c = (a ** 2 + b ** 2) ** 0.5 # We use ** instead of square root.
print("c =", c)
Хорошие, ответственные разработчики описывают каждый важный фрагмент кода, например, объясняют роль переменных; хотя следует отметить, что лучший способ комментировать переменные - это давать им однозначные имена.
Например, если конкретная переменная предназначена для хранения площади некоторого уникального квадрата, имя square_area, очевидно, будет лучше, чем aunt_jane
Мы говорим, что имя комментирует самого себя.
Комментарии могут быть полезны и в другом отношении - вы можете использовать их, чтобы пометить фрагмент кода, который в настоящее время не нужен по какой-либо причине. Посмотрите на пример ниже, если вы раскомментируете выделенную строку, это повлияет на вывод кода:
# This is a test program.
x = 1
y = 2
# y = y + x
print(x + y)
Это часто делается во время тестирования программы, чтобы изолировать место, где может быть скрыта ошибка.
Если вы хотите быстро прокомментировать или раскомментировать несколько строк кода, выберите строки, которые вы хотите изменить, и используйте следующую комбинацию клавиш:
Замечание, вставленное в программу, которое опускается во время выполнения, называется комментарием.
Как оставить такой комментарий в исходном коде? Это должно быть сделано так, чтобы Python не интерпретировал это как часть кода.
Всякий раз, когда Python встречает комментарий в вашей программе, этот комментарий полностью прозрачен для него - с точки зрения Python, это всего лишь один пробел (независимо от того, какова длина настоящего комментария).
В Python комментарий - это кусок текста, который начинается со знака # (решетка) и продолжается до конца строки.
Если вы хотите, чтобы комментарий занимал несколько строк, вы должны поставить перед всеми ними хеш.
Прямо как здесь:
# This program evaluates the hypotenuse c.
# a and b are the lengths of the legs.
a = 3.0
b = 4.0
c = (a ** 2 + b ** 2) ** 0.5 # We use ** instead of square root.
print("c =", c)
Хорошие, ответственные разработчики описывают каждый важный фрагмент кода, например, объясняют роль переменных; хотя следует отметить, что лучший способ комментировать переменные - это давать им однозначные имена.
Например, если конкретная переменная предназначена для хранения площади некоторого уникального квадрата, имя square_area, очевидно, будет лучше, чем aunt_jane
Мы говорим, что имя комментирует самого себя.
Комментарии могут быть полезны и в другом отношении - вы можете использовать их, чтобы пометить фрагмент кода, который в настоящее время не нужен по какой-либо причине. Посмотрите на пример ниже, если вы раскомментируете выделенную строку, это повлияет на вывод кода:
# This is a test program.
x = 1
y = 2
# y = y + x
print(x + y)
Это часто делается во время тестирования программы, чтобы изолировать место, где может быть скрыта ошибка.
Если вы хотите быстро прокомментировать или раскомментировать несколько строк кода, выберите строки, которые вы хотите изменить, и используйте следующую комбинацию клавиш:
- CTRL + / (Windows)
- CMD + / (Mac OS)