Комментирование в Python
При работе с большим количеством кода
хорошей практикой является комментирование
отдельных строк для его пояснения.
Например, 'этот код предназначен
для вывода типа данных'. Для комментариев
в Python используется
# этот код предназначен для вывода типа данных:
print(type(12))
print(type('hello, world!'))
print(type([1, 2, 3]))
Можно комментировать и несколько строк. Делается это с помощью тройных одинарных кавычек, расположенных в начале и конце такой строки:
'''
вывод типа данных с помощью
функций type() и
print():
'''
print(type(12))
print(type('hello, world!'))
print(type([1, 2, 3]))
Рекомендую не злоупотреблять комментированием. Например, если у вас осталась старая версия кода, появляется большой соблазн его закомментировать. Однакого этого не стоит делать, потому что когда у вас накопится достаточно много кода в скрипте, комментированные строки будут мешать его чтению. Поэтому лучше всего просто перенести важный, но неиспользуемый код в какой-нибудь отдельный файлик с заметками.