Доброго времени суток, читатели, зрители моего канала programmer's notes. Не забывайте подписываться и писать свои комментарии к моим статьям и видео.
А это ссылки на подборку по основному курсу по Python
Комментирование в программах на языке Python
Написав философское эссе по поводу комментирования программ, я вдруг вспомнил, что в базовом курсе у меня нет статьи о комментариях в языке Python. Для полноты изложения я решил добавить такую статью.
Простые комментарии
В Python для включения в программу комментария используется знак '#' (решётка).
- Комментарий в отдельной строке
# получить список файлов, содержащих списки сотрудников
ls = lst() - Встроенный комментарий. Комментарий помещается в конце исполняемой строки
A = B = C = 0 # инициализация переменных - Если нужно сделать многострочный комментарий, то каждая строка будет начинаться с '#'.
Строковая документация
В Python есть специальные многострочный комментарии. Обычно их используют для комментария функций или методов (строковая документация по функции). Такие комментарии выделяются с двух сторон тройными кавычками. Одинарными или двойными. Такой комментарий может быть в нескольких строках.
Если обычный комментарий игнорируется интерпретатором, то данный комментарий компилируется в результирующий байт-код.
На картинке представлена программа с таким комментарием.
Если выполнить в программе
help(proc1)
то будет выведено
Help on function proc1 in module __main__:
proc1()
пример использования
функции
globals
Более удобный вариант
print(proc1.__doc__)
Смысл такого комментария-документации заключается в том, что если у вас есть файл с текстом, состоящим из множества функций, то имея список функций можно получить по каждой из них помощь.
Конечно, комментарии с тройными кавычками могут быть размещены в любом месте программы, но обычно этим не пользуются.
Хорошего программирования. Оставляйте свои комментарии, не забывайте про лайки и подписывайтесь на мой канал programmer's notes.
