Основные тезисы
1. Комментарии используются, чтобы оставить дополнительную информацию в коде. Они опускаются во время выполнения. Информация, оставленная в исходном коде, адресована читателям. В Python комментарий - это фрагмент текста, который начинается с #. Комментарий продолжается до конца строки.
2. Если вы хотите разместить комментарий, который занимает несколько строк, вы должны поместить # перед ними. Кроме того, вы можете использовать комментарий, чтобы отметить фрагмент кода, который в данный момент не нужен (см. Последнюю строку фрагмента ниже), например:
# This program prints
# an introduction to the screen.
print("Hello!") # Invoking the print() function
# print("I'm Python.")
3. Когда это возможно и оправдано, вы должны присваивать переменным самокомментирующие имена, например, если вы используете две переменные для хранения длины и ширины чего-либо, имена переменных length и width могут быть лучшим выбором, чем myvar1 и myvar2.
4. Важно использовать комментарии, чтобы облегчить понимание программ, а также использовать читаемые и значимые имена переменных в коде. Однако не менее важно не использовать имена переменных, которые вводят в заблуждение, или оставлять комментарии, содержащие неверную информацию!
5. Комментарии могут быть важны, когда вы через некоторое время читаете ваш собственный код (поверьте, разработчики забывают, что делает их собственный код), и когда другие читают ваш код (это поможет им быстрее понять, что делают ваши программы и как они это делают).
Упражнение 1
Каков результат следующего фрагмента?
# print("String #1")
print("String #2")
Упражнение 2
Что произойдет, когда вы запустите следующий код?
# This is
a multiline
comment. #
print("Hello!")