Комментарии в коде: почему, как и когда
Вы можете добавить несколько слов, адресованных не Python, а людям, обычно, чтобы объяснить другим читателям кода, как работают приемы, используемые в коде, или значения переменных, и, в конце концов, чтобы хранить информацию о том, кто автор и когда была написана программа.
Вставленное в программу замечание, которое опускается во время выполнения, называется комментарием.
Как оставить такой комментарий в исходном коде? Это должно быть сделано так, чтобы Python не интерпретировал его как часть кода.
Всякий раз, когда Python встречает комментарий в вашей программе, комментарий становится для него полностью прозрачным - с точки зрения Python, это всего лишь один пробел (независимо от того, какова длина реального комментария).
В Python комментарий - это фрагмент текста, который начинается со знака # (hash) и продолжается до конца строки.
Если вы хотите, чтобы комментарий занимал несколько строк, вы должны поместить хеш перед ними всеми.
Так же, как здесь:
# 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)
Хорошие, ответственные разработчики описывают каждый важный фрагмент кода, например, объясняют роль переменных; хотя следует отметить, что лучший способ комментирования переменных - дать им однозначное имя.
Например, если определенная переменная предназначена для хранения области некоторого уникального квадрата, имя squareArea, очевидно, будет лучше, чем auntJane.
Мы говорим, что имя само комментируется.
Комментарии могут быть полезны в другом отношении - вы можете использовать их, чтобы отметить фрагмент кода, который в настоящее время не нужен по какой-либо причине. Посмотрите на пример ниже, если вы раскомментируете выделенную строку, это повлияет на вывод кода:
# This is a test program.
x = 1
y = 2
# y = y + x
print(x + y)
Это часто делается во время тестирования программы, чтобы изолировать место, где может быть скрыта ошибка.
Подсказка
Если вы хотите быстро прокомментировать или раскомментировать несколько строк кода, выберите строки, которые вы хотите изменить, и используйте следующую комбинацию клавиш: CTRL + / (Windows) или CMD + / (Mac OS). Это очень полезный трюк, не так ли? Попробуйте этот код в Sandbox.