Программирование на языке Python требует пояснений, подбора правильного названия функций, организации кода. Чтобы улучшить исходный текст программы, сделать его читабельным, используются комментарии.
Комментарии в Python – пояснения исходного текста программы. Применяются для определения работы классов, функций, значения переменной.
Примечания оставляют разработчики, для дальнейшего пересмотра строк кода. Они раскрывают смысл написанной программы. Используя комментарии или заметки, работать с кодом может другой программист.
Виды комментариев Python
Существует 2 вида комментариев языка Python: однострочные и многострочные. Применение определённого типа зависит от количества символов.
Началом однострочных комментариев является значок хештега (#). Возможно написание заметки возле оператора кода. Используется при написании дополнительных указаний, не превышающих 70-72 символов.
print("Hello, World!") # написан текст «Привет, мир!»
Текст многострочного комментария разбивается несколькими строками. Каждая начинается с хештега. Перенос текста следующей строчки необходим, если длина заметки превышает 72 символа.
#Рассматриваемое пояснение разделено
# несколькими строчками.
Второй способ – многострочный текст выделяется тройными кавычками.
"""
Данная функция выполняет множество действий,
она заключена в тройные кавычки.
"""
Удобство второго способа – расположение заметки в любой части кода. Существуют нюансы работы этого способа. Размещая пояснение после функции/метода, язык программирования воспримет комментарий, как часть функции/метода.
Как оставить комментарии в Python
Начать пояснение следует с хештег символа (#), заканчивается текст концом строчки. Расположение зависит от типа комментария. Заметку можно оставить перед рабочей функцией и после неё.
# Текст находится перед рабочей частью.
print("Hello, World!") # Заметка оставлена после определённой функции
Советы как правильно составить комментарий
Правильно составленное разъяснение поможет воспринять информацию со старого кода. С ним смогут работать другие программисты. Составляя заметку, обратите внимание на следующие факторы:
Количество символов – не пишите длинные словосочетания. Сокращайте ненужную информацию.
Актуальность – меняйте содержание после изменения кода. Старая информация запутает программиста.
Содержательность – указывайте понятную информацию. Код должен легко восприниматься человеком.
Полезность – не объясняйте простые вещи. Лишняя информация увеличит количество символов кода, сделает огромным, нечитабельным.
Не пытайтесь вместить длинные тексты в одну строчку. При большом количестве символов, разбейте их несколькими строчками.
