2.5.1.2 LAB: Комментарии
Цели
Сценарий
Код в редакторе содержит комментарии. Попробуйте улучшить его: добавьте или удалите комментарии там, где вы сочтете нужным (да, иногда удаление комментария может сделать код более читабельным) и измените имена переменных там, где, по вашему мнению, это улучшит понимание кода.
ПРИМЕЧАНИЕ
Комментарии очень важны. Они используются не только для облегчения понимания ваших программ, но и для отключения тех фрагментов кода, которые в настоящее время не нужны (например, когда вам нужно протестировать только некоторые части вашего кода и игнорировать другие). Хорошие программисты описывают каждый важный фрагмент кода и дают самокомментирующие имена переменным, поскольку иногда гораздо лучше оставить информацию в коде.
Хорошо использовать читаемые имена переменных, а иногда лучше разделить код на именованные части (например, функции). В некоторых ситуациях рекомендуется более четко описывать этапы вычислений.
И еще одно: может случиться так, что комментарий содержит неверную или неверную информацию - никогда не следует делать это специально!
Дано
# this program computes the number of seconds in a given number of hours
# this program has been written two days ago
a = 2 # number of hours
seconds = 3600 # number of seconds in 1 hour
print("Hours: ", a) #printing the number of hours
# print("Seconds in Hours: ", a * seconds) # printing the number of seconds in a given number of hours
#here we should also print "Goodbye", but a programmer didn't have time to write any code
#this is the end of the program that computes the number of seconds in 3 hour
- знакомство с концепцией комментариев в Python;
- использование и не использование комментариев;
- замена комментариев кодом;
- экспериментируем с кодом Python.
Сценарий
Код в редакторе содержит комментарии. Попробуйте улучшить его: добавьте или удалите комментарии там, где вы сочтете нужным (да, иногда удаление комментария может сделать код более читабельным) и измените имена переменных там, где, по вашему мнению, это улучшит понимание кода.
ПРИМЕЧАНИЕ
Комментарии очень важны. Они используются не только для облегчения понимания ваших программ, но и для отключения тех фрагментов кода, которые в настоящее время не нужны (например, когда вам нужно протестировать только некоторые части вашего кода и игнорировать другие). Хорошие программисты описывают каждый важный фрагмент кода и дают самокомментирующие имена переменным, поскольку иногда гораздо лучше оставить информацию в коде.
Хорошо использовать читаемые имена переменных, а иногда лучше разделить код на именованные части (например, функции). В некоторых ситуациях рекомендуется более четко описывать этапы вычислений.
И еще одно: может случиться так, что комментарий содержит неверную или неверную информацию - никогда не следует делать это специально!
Дано
# this program computes the number of seconds in a given number of hours
# this program has been written two days ago
a = 2 # number of hours
seconds = 3600 # number of seconds in 1 hour
print("Hours: ", a) #printing the number of hours
# print("Seconds in Hours: ", a * seconds) # printing the number of seconds in a given number of hours
#here we should also print "Goodbye", but a programmer didn't have time to write any code
#this is the end of the program that computes the number of seconds in 3 hour