Как писать комментарии и многострочные комментарии в Python | Месяц тем Python

задняя часть Python
Как писать комментарии и многострочные комментарии в Python | Месяц тем Python

Эта статья участвует в "Месяце тем Python", подробнее см.Ссылка на мероприятие

содержание

Комментарии подобны дорожным знакам, которые делают данный код понятным и легко читаемым. В Python мы можем добавлять однострочные и многострочные комментарии Python. В этом руководстве подробно рассматриваются оба метода. Прочитав эту статью, вы узнаете, как добавлять комментарии Python и какой стиль использовать.

Написание комментариев — хорошая практика программирования. Это неисполняемые части кода, но очень важные в программе. Они не только помогают другим программистам, работающим над тем же проектом, но и тестировщики могут также обращаться к ним, чтобы уточнить тестирование белого ящика.

Рекомендуется добавлять комментарии при создании или обновлении программ, иначе вы можете потерять контекст. Комментарии, написанные позже, могут не дать желаемого эффекта.

🎪 1. Как использовать однострочные комментарии в Python?

Если вам нужны короткие, быстрые комментарии для отладки, вы можете предпочесть использовать однострочные комментарии Python. Однострочные комментарии начинаются со знака решетки (#) и автоматически заканчиваются EOL (конец строки).

# 好的代码是自我记录的。

print("Learn Python Step by Step!")

# 定义月份列表
months = ['Jan', 'Feb', 'Mar', 'Apr', 'May', 'Jun', 'Jul','Aug','Sep','Oct','Nov','Dec']

# 打印日历月份的功能
def showCalender(months):
    # For 循环遍历列表并打印每个月的名称
    for month in months:
        print(month)

showCalender(months)

вернуться к содержанию

🍰 2. Как использовать многострочные комментарии в Python?

Python позволяет комментировать несколько строк. Такие комментарии называются многострочными комментариями или блочными комментариями. Вы можете использовать эту аннотацию для описания более сложного контента.

Эта расширенная форма комментария применяется к части или всему последующему коду. Вот пример использования многострочных комментариев Python.

🍬 2.1 Комментарии с хэштегами

Чтобы добавить многострочный комментарий, каждая строка должна начинаться со знака решетки (#), за которым следует пробел. Вы можете разбивать комментарии на абзацы. Просто добавьте пустую строку со знаком фунта между каждым абзацем.

Уведомление: символ (#) также известен как октоторп. Термин происходит от группы инженеров Bell Labs, когда они работали над первым проектом кнопочной клавиатуры.

# 要学习任何语言，您必须遵循以下规则。
# 1. 了解基本语法、数据类型、控制结构和条件语句。
# 2. 学习错误处理和文件 I/O。
# 3. 阅读高级数据结构。
# 4. 编写函数并遵循 OOP 概念。

def main():
    print("Let's start to learn Python.")
...

вернуться к содержанию

🎯 3. Как использовать строки документации в Python?

В Python есть функция docstring (или docstring). Он предоставляет программистам простой способ добавлять быстрые комментарии к каждому модулю, функции, классу и методу Python.

Вы можете определить строки документации, добавив их как строковые константы. Это должен быть первый оператор в определении объекта (модуля, функции, класса и метода).

Строки документации имеют более широкий охват, чем комментарии Python. Следовательно, он должен описывать, что делает функция, а не как. Кроме того, рекомендуется иметь строки документации для всех функций программы.

🛫 3.1 Используйте тройные кавычки для строк документации

Вы можете определить строки документации с помощью тройных кавычек. Добавьте один в начало строки и второй в конец строки. Как и многострочные комментарии, строки документации могут накладываться на несколько строк.

Примечание. Строки, определенные в тройных кавычках, в Python являются строками документации. Однако он может показаться вам обычным комментарием.

🎡 3.2 В чем разница между строками документации и комментариями в Python?

Строки, начинающиеся с тройных кавычек, по-прежнему являются обычными строками, но могут расширяться на несколько строк. Это означает, что они являются исполняемыми операторами. Если они не отмечены, они будут удалены сборщиком мусора после выполнения кода.

Интерпретатор Python не игнорирует их, как комментарии. Однако, если такие строки следуют непосредственно за определением функции или класса или над модулем, они становятся строками документации. Вы можете получить к ним доступ, используя следующие специальные переменные.

myobj.__doc__

пример

def theFunction():
    '''
This function demonstrate the use of docstring in Python.
    '''
    print("Python docstrings are not comments.")

print("\nJust printing the docstring value...")
print(theFunction.__doc__)

вернуться к содержанию

🍺 Краткое резюме — комментарии и строки документации Python

Комментарии и строки документации повышают ценность программы. Они делают ваши программы более читабельными и удобными в сопровождении. Даже если позже вам понадобится провести рефакторинг того же кода, использовать имеющиеся аннотации будет проще.

Только 10% жизненного цикла программного обеспечения тратится на разработку, а остальные 90% тратятся на сопровождение.

Поэтому всегда добавляйте релевантные и полезные комментарии или строки документации, поскольку они способствуют более тесному сотрудничеству и ускоряют рефакторинг кода.

Если вам понравилась эта статья и вы хотите увидеть больше таких статей, вы можете посмотреть здесь, вот краткое изложение всего моего оригинального и исходного кода:

Github,Gitee

🧵 Другие статьи по теме

Рекомендуемые статьи из прошлого:

Если вы действительно узнали что-то новое из этой статьи, ставьте лайк, добавляйте в закладки и делитесь с друзьями. 🤗Наконец, не забудьте поддержать ❤ или 📑

Категории