В этом руководстве мы научимся создавать комментарии в Python с помощью примеров.
Видео: комментарии в Python
Комментарии - это описания, которые помогают программистам лучше понять назначение и функциональность программы.
Интерпретатор Python полностью игнорирует их.
Преимущества использования комментариев
Использование комментариев в программах делает наш код более понятным. Это делает программу более читаемой, что помогает нам вспомнить, почему были написаны определенные блоки кода.
Помимо этого, комментарии также могут использоваться для игнорирования некоторого кода при тестировании других блоков кода. Это предлагает простой способ предотвратить выполнение некоторых строк или написать быстрый псевдокод для программы.
Однострочные комментарии в Python
В Python мы используем символ решетки #для написания однострочного комментария.
Пример 1: Написание однострочных комментариев
# printing a string print('Hello world')
Вывод
Привет мир
Вот комментарий:
# printing a string
Эта строка игнорируется интерпретатором Python.
Все, что идет после #, игнорируется. Итак, мы также можем записать указанную выше программу в одной строке как:
print('Hello world') #printing a string
Результат этой программы будет таким же, как в Примере 1 . Интерпретатор игнорирует весь текст после #.
Многострочные комментарии в Python
Python не предлагает отдельного способа написания многострочных комментариев. Однако есть и другие способы обойти эту проблему.
Мы можем использовать #в начале каждой строки комментария несколько строк.
Пример 2: Использование нескольких #
# it is a # multiline # comment
Здесь каждая строка рассматривается как отдельный комментарий, и все они игнорируются.
Строковые литералы для многострочных комментариев
Несмотря на то, что уникального способа написания многострочных комментариев в Python нет, мы знаем, что интерпретатор Python игнорирует строковые литералы, которые не присвоены переменной.
Итак, мы можем даже написать однострочный комментарий как:
#this is a comment 'this is an unassigned string as a comment '
Здесь мы видим, что вторая строка программы представляет собой строку, но не присвоена какой-либо переменной или функции. Итак, интерпретатор игнорирует строку.
Аналогичным образом мы можем использовать многострочные строки (тройные кавычки) для написания многострочных комментариев.
Цитата может быть 'или ".
Пример 3: Использование строковых литералов для написания многострочных комментариев
''' I am a multiline comment! ''' print("Hello World")
Здесь многострочная строка не назначается какой-либо переменной, поэтому интерпретатор игнорирует ее. Хотя технически это не многострочный комментарий, его можно использовать как один.
Строки документации Python
По соглашению тройные кавычки, которые появляются сразу после определения функции, метода или класса, являются строками документации (строками документации).
Строки документации связаны с объектами, и к ним можно получить доступ с помощью __doc__атрибута.
Чтобы узнать больше, посетите строки документации Python.
Как писать лучшие комментарии?
- Используйте комментарии, чтобы описать, что делает функция, а не конкретные детали того, как она это делает.
- Постарайтесь удалить как можно больше повторяющихся комментариев. Попробуйте написать код, который может объяснить себя, используя лучший выбор имени функции / переменной.
- Старайтесь делать комментарии как можно короче и лаконичнее.
