2.5.1.3 Ключевые выводы раздела комментарии
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!")
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!")