Резюме
В этой статье вы узнаете, как добавлять комментарии в свой код. Вы изучите различные виды комментариев Python, включая блочные комментарии, встроенные комментарии и документированные строки.
Введение в комментарии Python
Иногда вам нужно задокументировать код, который вы пишете. Например, вы можете отметить, как работает тот или иной фрагмент кода. Для этого вы используете комментарии.
Обычно вы используете комментарии для объяснения формул, алгоритмов и сложной бизнес-логики.
При выполнении программы интерпретатор Python игнорирует комментарии и интерпретирует только код.
Python предоставляет три типа комментариев:
- блочные комментарии
- встроенные комментарии
- строки документации
Блочные комментарии (комментирование блока кода)
Комментарий к блоку объясняют код, который следует за ним. Обычно отступ комментария к блоку устанавливается на том же уровне, что и блок кода.
Чтобы создать блочный комментарий, вы начинаете с одного знака решетки (#), за которым следует один пробел и текстовая строка. Например:
Встроенные комментарии
Когда вы размещаете комментарий в той же строке, что и оператор, вы получаете встроенный комментарий.
Подобно блочному комментарию, встроенный комментарий начинается с одного знака решетки (#), за которым следует пробел и текстовая строка.
Следующий пример иллюстрирует встроенный комментарий:
Строки документации Python
Строка документации — это строковый литерал, который вы помещаете в первые строки блока кода, например функции.
В отличие от обычного комментария, доступ к строке документации можно получить во время выполнения с помощью obj.__doc__ атрибута, где obj — имя функции.
Обычно вы используете строку документации для автоматического создания документации по коду.
Строго говоря, строки документации не являются комментариями. Они создают анонимные переменные, ссылающиеся на строки. Кроме того, они не игнорируются интерпретатором Python.
Python предоставляет два типа строк документации: однострочные и многострочные.
1. Однострочные строки документации
Как следует из названия, однострочная строка документации соответствует одной строке. Однострочная строка документации начинается с тройных кавычек (""") и заканчивается тройными кавычками ("""). Кроме того, ни до, ни после однострочной строки документации не будет пустых строк.
Следующий пример иллюстрирует однострочную строку документации в quicksort() функции:
2. Многострочные строки документации
В отличие от однострочной строки документации, многострочная строка документации может охватывать несколько строк. Многострочная строка документации также начинается с тройных кавычек (""") и заканчивается тройными кавычками (""").
В следующем примере показано, как использовать многострочные строки документации:
Многострочные комментарии Python
Python не поддерживает многострочные комментарии.
Однако вы можете использовать однострочные строки документации в качестве многострочных комментариев. Это также рекомендовал Гвидо ван Россум , создатель Python.
Хорошей практикой является составление вашего комментария ясным, кратким и пояснительным. Конечная цель — сэкономить время и энергию для вас и других разработчиков, которые позже будут работать над кодом.
Краткое содержание
- При необходимости используйте комментарии для документирования вашего кода
- Блочный комментарий и встроенный комментарий начинаются со знака решетки (#)
- Используйте строки документации для функций, модулей и классов
.
❤️ Если вам понравилась статья, ставьте лайк и подписывайтесь на мой канал "Заходи в Ай-Ти".
👍 Если у вас остались вопросы или есть интересные темы, которые вы хотите, чтобы я разобрал, то пишите в комментариях. Ваше мнение очень важно для меня!
.
#python основы #основы языка python #основы пайтон #комментарии в python #многострочный комментарий python #однострочный комментарий python #какой символ используется для комментариев в python
