При написании кода на Python всегда полезно делать код легко читаемым. Организация кода, присвоение переменным и функциям описательных имен – это несколько способов сделать это.
Еще один способ улучшить читабельность вашего кода – это использовать комментарии. Комментарий – это понятное человеку объяснение или аннотация, которая используется для объяснения кода. Например, если вы написали сложное регулярное выражение, вы добавите комментарий, описывающий, что делает код.
Добавление комментариев к вашему коду Python сэкономит вам много времени и усилий, если вы посмотрите на свой код в будущем. Допустим, вы хотите изменить сценарий, который вы написали несколько месяцев или лет назад. Скорее всего, вы не помните, почему вы написали какой-то сложный кусок кода, если вы не добавили комментарий. Комментарии также помогают другим разработчикам понять ваш код и его назначение.
Комментарии должны быть краткими и точными. Не объясняйте что-то очевидное для читателя.
В этой статье рассматриваются основы написания комментариев на Python.
Написание комментариев в Python
Python игнорирует все, что написано в строке после хеш-метки (#).
Комментарии могут быть добавлены в начале строки или встроены в другой код:
# Это комментарий Python.
print("Привет Мир") # Это встроенный комментарий Python.
Пробел после хеш-метки не обязателен, но он улучшит читабельность комментария.
Символ хеша внутри строкового литерала не указывает на начало строки комментария. Это просто хэш-символ:
paragraph = "# Хэш внутри кавычек-это не комментарий."
Комментарии должны быть на том же уровне отступа, что и код под ними:
```py
def factorial(n):
if n == 0:
return 1
else:
# Используйте функцию факториала
return n * factorial(n-1)
Если ваш текстовый редактор поддерживает подсветку синтаксиса, комментарии обычно отображаются зеленым цветом.
Комментарии также полезны при отладке скрипта. Вместо удаления некоторых строк или блоков, вы можете закомментировать их:
# for fruit in fruits: # print(fruit)
Многострочные комментарии в Python (блоки комментариев)
В отличие от других популярных языков программирования, Python поддерживает только однострочные комментарии.
Самый простой способ написать многострочные комментарии в Python – добавить однострочные комментарии один за другим:
# Это первая строка. # Это вторая строка.
Другой вариант – использовать строки документации.
Строки документации – это многострочные строковые литералы, которые используются для документирования того, что делает модуль, функция, класс или метод.
Строка документа начинается и заканчивается тройными двойными кавычками ( “””) и может занимать одну или несколько строк:
"""Это многострочная строка документа. """
Строки документации не являются технически комментариями. Когда строка документа встречается в качестве первого оператора в модуле, функции, классе или методе, она заканчивается в байт-коде и становится специальным атрибутом __doc__ этого объекта. Вы должны предпочесть использование обычных однострочных хеш-комментариев.
Python
Если вы читаете скрипты Python, вы можете заметить, что в некоторых из них первая строка начинается с символов #! и пути к интерпретатору Python:
#!/usr/bin/env python3
Эта последовательность символов вызывается shebang и используется для указания операционной системе, какой интерпретатор использовать для анализа остальной части файла. Скрипты, которые начинаются с shebang и являются исполняемыми, могут запускаться в терминале без ввода python перед именем скрипта.
Поскольку строка shebang начинается с символа хеша, она рассматривается как комментарий и автоматически игнорируется интерпретатором Python.
Вывод
Написание комментариев является хорошей практикой и помогает другим разработчикам, в том числе будущим, понять, что делает код. В Python все после хеш-метки ( #) и до конца строки считается комментарием.
Если у вас есть какие-либо вопросы или отзывы, не стесняйтесь оставлять комментарии.